other/Puppet: modules/archive/REFERENCE.md annotate

annotate modules/archive/REFERENCE.md @ 454:d0e7979c7e8c

Update PHP configs for Ubuntu Mostly fixing some INI naming so that it is consistent between packages and what we write (so we don't end up with mixed/duplicate content)

author	IBBoard <dev@ibboard.co.uk>
date	Sun, 13 Aug 2023 15:26:37 +0100
parents	3fce34f642f1
children	adf6fe9bbc17

rev	line source
386 3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1 # Reference
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	2
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	3 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	4
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	5 ## Table of Contents
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	6
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	7 ### Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	8
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	9 #### Public Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	10
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	11 * [`archive`](#archive): Manages archive module's dependencies.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	12 * [`archive::staging`](#archivestaging): Class: archive::staging ======================= backwards compatibility class for staging module.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	13
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	14 #### Private Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	15
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	16 * `archive::params`: OS specific `archive` settings such as default user and file mode.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	17
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	18 ### Defined types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	19
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	20 * [`archive::artifactory`](#archiveartifactory): Define: archive::artifactory ============================ archive wrapper for downloading files from artifactory Parameters ---------- * p
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	21 * [`archive::download`](#archivedownload): == Definition: archive::download Archive downloader with integrity verification. Parameters: - $url: - $digest_url: - *$digest_string: D
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	22 * [`archive::go`](#archivego): download from go
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	23 * [`archive::nexus`](#archivenexus): define: archive::nexus ====================== archive wrapper for downloading files from Nexus using REST API. Nexus API: https://repository
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	24
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	25 ### Resource types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	26
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	27 * [`archive`](#archive): Manage archive file download, extraction, and cleanup.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	28
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	29 ### Functions
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	30
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	31 #### Public Functions
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	32
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	33 * [`archive::artifactory_checksum`](#archiveartifactory_checksum): A function that returns the checksum value of an artifact stored in Artifactory
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	34 * [`archive::artifactory_latest_url`](#archiveartifactory_latest_url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	35 * [`archive::parse_artifactory_url`](#archiveparse_artifactory_url): A function to parse an Artifactory maven 2 repository URL
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	36
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	37 #### Private Functions
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	38
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	39 * `archive::assemble_nexus_url`: Assembles a complete nexus URL from the base url and query parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	40 * `archive::go_md5`: Retrieves and returns specific file's md5 from GoCD server md5 checksum file
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	41
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	42 ## Classes
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	43
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	44 ### <a name="archive"></a>`archive`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	45
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	46 Manages archive module's dependencies.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	47
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	48 #### Examples
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	49
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	50 ##### On Windows, ensure 7zip is installed using the default `chocolatey` provider.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	51
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	52 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	53 include archive
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	54 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	55
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	56 ##### On Windows, install a 7zip MSI with the native `windows` package provider.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	57
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	58 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	59 class { 'archive':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	60 seven_zip_name => '7-Zip 9.20 (x64 edition)',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	61 seven_zip_source => 'C:/Windows/Temp/7z920-x64.msi',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	62 seven_zip_provider => 'windows',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	63 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	64 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	65
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	66 ##### Install the AWS CLI tool. (Not supported on Windows).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	67
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	68 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	69 class { 'archive':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	70 aws_cli_install => true,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	71 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	72 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	73
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	74 ##### Deploy a specific archive
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	75
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	76 ```puppet
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	77 class { 'archive':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	78 archives => { '/tmp/jta-1.1.jar' => {
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	79 'ensure' => 'present',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	80 'source' => 'http://central.maven.org/maven2/javax/transaction/jta/1.1/jta-1.1.jar',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	81 }, }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	82 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	83 ```
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	84
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	85 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	86
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	87 The following parameters are available in the `archive` class:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	88
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	89 * [`seven_zip_name`](#seven_zip_name)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	90 * [`seven_zip_provider`](#seven_zip_provider)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	91 * [`seven_zip_source`](#seven_zip_source)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	92 * [`aws_cli_install`](#aws_cli_install)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	93 * [`gsutil_install`](#gsutil_install)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	94 * [`archives`](#archives)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	95
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	96 ##### <a name="seven_zip_name"></a>`seven_zip_name`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	97
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	98 Data type: `Optional[String[1]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	99
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	100 7zip package name. This parameter only applies to Windows.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	101
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	102 Default value: `$archive::params::seven_zip_name`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	103
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	104 ##### <a name="seven_zip_provider"></a>`seven_zip_provider`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	105
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	106 Data type: `Optional[Enum['chocolatey','windows','']]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	107
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	108 7zip package provider. This parameter only applies to Windows where it defaults to `chocolatey`. Can be set to an empty string, (or `undef` via hiera), if you don't want this module to manage 7zip.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	109
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	110 Default value: `$archive::params::seven_zip_provider`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	111
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	112 ##### <a name="seven_zip_source"></a>`seven_zip_source`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	113
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	114 Data type: `Optional[String[1]]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	115
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	116 Alternative package source for 7zip. This parameter only applies to Windows.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	117
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	118 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	119
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	120 ##### <a name="aws_cli_install"></a>`aws_cli_install`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	121
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	122 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	123
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	124 Installs the AWS CLI command needed for downloading from S3 buckets. This parameter is currently not implemented on Windows.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	125
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	126 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	127
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	128 ##### <a name="gsutil_install"></a>`gsutil_install`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	129
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	130 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	131
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	132 Installs the GSUtil CLI command needed for downloading from GS buckets. This parameter is currently not implemented on Windows.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	133
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	134 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	135
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	136 ##### <a name="archives"></a>`archives`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	137
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	138 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	139
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	140 A hash of archive resources this module should create.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	141
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	142 Default value: `{}`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	143
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	144 ### <a name="archivestaging"></a>`archive::staging`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	145
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	146 Class: archive::staging
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	147 =======================
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	148
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	149 backwards compatibility class for staging module.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	150
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	151 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	152
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	153 The following parameters are available in the `archive::staging` class:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	154
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	155 * [`path`](#path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	156 * [`owner`](#owner)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	157 * [`group`](#group)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	158 * [`mode`](#mode)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	159
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	160 ##### <a name="path"></a>`path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	161
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	162 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	163
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	164
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	165
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	166 Default value: `$archive::params::path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	167
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	168 ##### <a name="owner"></a>`owner`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	169
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	170 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	171
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	172
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	173
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	174 Default value: `$archive::params::owner`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	175
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	176 ##### <a name="group"></a>`group`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	177
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	178 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	179
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	180
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	181
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	182 Default value: `$archive::params::group`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	183
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	184 ##### <a name="mode"></a>`mode`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	185
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	186 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	187
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	188
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	189
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	190 Default value: `$archive::params::mode`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	191
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	192 ## Defined types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	193
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	194 ### <a name="archiveartifactory"></a>`archive::artifactory`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	195
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	196 Define: archive::artifactory
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	197 ============================
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	198
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	199 archive wrapper for downloading files from artifactory
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	200
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	201 Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	202 ----------
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	203
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	204 * path: fully qualified filepath for the download the file or use archive_path and only supply filename. (namevar).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	205 * ensure: ensure the file is present/absent.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	206 * url: artifactory download URL.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	207 * owner: file owner (see archive params for defaults).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	208 * group: file group (see archive params for defaults).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	209 * mode: file mode (see archive params for defaults).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	210 * archive_path: the parent directory of local filepath.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	211 * extract: whether to extract the files (true/false).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	212 * creates: the file created when the archive is extracted (true/false).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	213 * cleanup: remove archive file after file extraction (true/false).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	214
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	215 Examples
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	216 --------
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	217
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	218 archive::artifactory { '/tmp/logo.png':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	219 url => 'https://repo.jfrog.org/artifactory/distributions/images/Artifactory_120x75.png',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	220 owner => 'root',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	221 group => 'root',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	222 mode => '0644',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	223 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	224
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	225 $dirname = 'gradle-1.0-milestone-4-20110723151213+0300'
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	226 $filename = "${dirname}-bin.zip"
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	227
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	228 archive::artifactory { $filename:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	229 archive_path => '/tmp',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	230 url => "http://repo.jfrog.org/artifactory/distributions/org/gradle/${filename}",
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	231 extract => true,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	232 extract_path => '/opt',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	233 creates => "/opt/${dirname}",
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	234 cleanup => true,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	235 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	236
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	237 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	238
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	239 The following parameters are available in the `archive::artifactory` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	240
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	241 * [`url`](#url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	242 * [`path`](#path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	243 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	244 * [`owner`](#owner)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	245 * [`group`](#group)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	246 * [`mode`](#mode)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	247 * [`extract`](#extract)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	248 * [`extract_path`](#extract_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	249 * [`creates`](#creates)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	250 * [`cleanup`](#cleanup)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	251 * [`username`](#username)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	252 * [`password`](#password)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	253 * [`archive_path`](#archive_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	254
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	255 ##### <a name="url"></a>`url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	256
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	257 Data type: `Stdlib::HTTPUrl`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	258
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	259
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	260
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	261 ##### <a name="path"></a>`path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	262
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	263 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	264
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	265
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	266
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	267 Default value: `$name`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	268
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	269 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	270
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	271 Data type: `Enum['present', 'absent']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	272
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	273
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	274
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	275 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	276
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	277 ##### <a name="owner"></a>`owner`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	278
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	279 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	280
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	281
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	282
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	283 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	284
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	285 ##### <a name="group"></a>`group`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	286
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	287 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	288
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	289
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	290
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	291 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	292
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	293 ##### <a name="mode"></a>`mode`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	294
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	295 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	296
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	297
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	298
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	299 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	300
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	301 ##### <a name="extract"></a>`extract`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	302
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	303 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	304
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	305
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	306
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	307 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	308
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	309 ##### <a name="extract_path"></a>`extract_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	310
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	311 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	312
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	313
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	314
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	315 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	316
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	317 ##### <a name="creates"></a>`creates`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	318
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	319 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	320
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	321
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	322
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	323 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	324
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	325 ##### <a name="cleanup"></a>`cleanup`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	326
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	327 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	328
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	329
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	330
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	331 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	332
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	333 ##### <a name="username"></a>`username`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	334
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	335 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	336
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	337
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	338
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	339 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	340
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	341 ##### <a name="password"></a>`password`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	342
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	343 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	344
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	345
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	346
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	347 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	348
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	349 ##### <a name="archive_path"></a>`archive_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	350
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	351 Data type: `Optional[Stdlib::Absolutepath]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	352
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	353
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	354
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	355 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	356
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	357 ### <a name="archivedownload"></a>`archive::download`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	358
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	359 == Definition: archive::download
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	360
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	361 Archive downloader with integrity verification.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	362
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	363 Parameters:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	364
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	365 - *$url:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	366 - *$digest_url:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	367 - *$digest_string: Default value undef
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	368 - *$digest_type: Default value "md5".
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	369 - *$timeout: Default value 120. (ignored)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	370 - *$src_target: Default value "/usr/src".
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	371 - *$allow_insecure: Default value false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	372 - *$follow_redirects: Default value false.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	373 - *$verbose: Default value true.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	374 - *$proxy_server: Default value undef.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	375 - *$user: The user used to download the archive
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	376
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	377 Example usage:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	378
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	379 archive::download {"apache-tomcat-6.0.26.tar.gz":
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	380 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	381 url => "http://archive.apache.org/dist/tomcat/tomcat-6/v6.0.26/bin/apache-tomcat-6.0.26.tar.gz",
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	382 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	383
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	384 archive::download {"apache-tomcat-6.0.26.tar.gz":
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	385 ensure => present,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	386 digest_string => "f9eafa9bfd620324d1270ae8f09a8c89",
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	387 url => "http://archive.apache.org/dist/tomcat/tomcat-6/v6.0.26/bin/apache-tomcat-6.0.26.tar.gz",
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	388 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	389
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	390 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	391
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	392 The following parameters are available in the `archive::download` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	393
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	394 * [`url`](#url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	395 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	396 * [`checksum`](#checksum)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	397 * [`digest_url`](#digest_url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	398 * [`digest_string`](#digest_string)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	399 * [`digest_type`](#digest_type)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	400 * [`timeout`](#timeout)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	401 * [`src_target`](#src_target)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	402 * [`allow_insecure`](#allow_insecure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	403 * [`follow_redirects`](#follow_redirects)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	404 * [`verbose`](#verbose)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	405 * [`path`](#path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	406 * [`proxy_server`](#proxy_server)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	407 * [`user`](#user)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	408
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	409 ##### <a name="url"></a>`url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	410
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	411 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	412
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	413
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	414
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	415 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	416
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	417 Data type: `Enum['present', 'absent']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	418
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	419
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	420
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	421 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	422
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	423 ##### <a name="checksum"></a>`checksum`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	424
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	425 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	426
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	427
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	428
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	429 Default value: ``true``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	430
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	431 ##### <a name="digest_url"></a>`digest_url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	432
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	433 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	434
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	435
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	436
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	437 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	438
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	439 ##### <a name="digest_string"></a>`digest_string`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	440
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	441 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	442
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	443
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	444
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	445 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	446
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	447 ##### <a name="digest_type"></a>`digest_type`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	448
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	449 Data type: `Enum['none', 'md5', 'sha1', 'sha2','sha256', 'sha384', 'sha512']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	450
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	451
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	452
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	453 Default value: `'md5'`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	454
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	455 ##### <a name="timeout"></a>`timeout`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	456
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	457 Data type: `Integer`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	458
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	459
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	460
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	461 Default value: `120`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	462
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	463 ##### <a name="src_target"></a>`src_target`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	464
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	465 Data type: `Stdlib::Compat::Absolute_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	466
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	467
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	468
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	469 Default value: `'/usr/src'`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	470
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	471 ##### <a name="allow_insecure"></a>`allow_insecure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	472
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	473 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	474
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	475
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	476
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	477 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	478
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	479 ##### <a name="follow_redirects"></a>`follow_redirects`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	480
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	481 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	482
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	483
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	484
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	485 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	486
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	487 ##### <a name="verbose"></a>`verbose`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	488
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	489 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	490
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	491
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	492
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	493 Default value: ``true``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	494
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	495 ##### <a name="path"></a>`path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	496
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	497 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	498
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	499
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	500
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	501 Default value: `$facts['path']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	502
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	503 ##### <a name="proxy_server"></a>`proxy_server`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	504
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	505 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	506
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	507
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	508
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	509 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	510
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	511 ##### <a name="user"></a>`user`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	512
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	513 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	514
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	515
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	516
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	517 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	518
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	519 ### <a name="archivego"></a>`archive::go`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	520
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	521 download from go
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	522
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	523 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	524
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	525 The following parameters are available in the `archive::go` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	526
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	527 * [`server`](#server)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	528 * [`port`](#port)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	529 * [`url_path`](#url_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	530 * [`md5_url_path`](#md5_url_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	531 * [`username`](#username)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	532 * [`password`](#password)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	533 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	534 * [`path`](#path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	535 * [`owner`](#owner)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	536 * [`group`](#group)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	537 * [`mode`](#mode)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	538 * [`extract`](#extract)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	539 * [`extract_path`](#extract_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	540 * [`creates`](#creates)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	541 * [`cleanup`](#cleanup)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	542 * [`archive_path`](#archive_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	543
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	544 ##### <a name="server"></a>`server`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	545
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	546 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	547
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	548
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	549
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	550 ##### <a name="port"></a>`port`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	551
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	552 Data type: `Integer`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	553
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	554
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	555
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	556 ##### <a name="url_path"></a>`url_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	557
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	558 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	559
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	560
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	561
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	562 ##### <a name="md5_url_path"></a>`md5_url_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	563
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	564 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	565
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	566
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	567
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	568 ##### <a name="username"></a>`username`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	569
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	570 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	571
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	572
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	573
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	574 ##### <a name="password"></a>`password`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	575
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	576 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	577
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	578
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	579
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	580 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	581
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	582 Data type: `Enum['present', 'absent']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	583
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	584
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	585
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	586 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	587
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	588 ##### <a name="path"></a>`path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	589
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	590 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	591
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	592
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	593
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	594 Default value: `$name`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	595
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	596 ##### <a name="owner"></a>`owner`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	597
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	598 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	599
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	600
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	601
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	602 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	603
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	604 ##### <a name="group"></a>`group`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	605
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	606 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	607
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	608
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	609
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	610 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	611
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	612 ##### <a name="mode"></a>`mode`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	613
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	614 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	615
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	616
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	617
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	618 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	619
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	620 ##### <a name="extract"></a>`extract`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	621
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	622 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	623
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	624
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	625
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	626 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	627
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	628 ##### <a name="extract_path"></a>`extract_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	629
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	630 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	631
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	632
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	633
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	634 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	635
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	636 ##### <a name="creates"></a>`creates`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	637
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	638 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	639
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	640
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	641
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	642 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	643
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	644 ##### <a name="cleanup"></a>`cleanup`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	645
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	646 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	647
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	648
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	649
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	650 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	651
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	652 ##### <a name="archive_path"></a>`archive_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	653
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	654 Data type: `Optional[Stdlib::Compat::Absolute_path]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	655
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	656
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	657
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	658 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	659
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	660 ### <a name="archivenexus"></a>`archive::nexus`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	661
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	662 define: archive::nexus
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	663 ======================
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	664
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	665 archive wrapper for downloading files from Nexus using REST API. Nexus API:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	666 https://repository.sonatype.org/nexus-restlet1x-plugin/default/docs/path__artifact_maven_content.html
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	667
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	668 Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	669 ----------
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	670
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	671 Examples
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	672 --------
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	673
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	674 archive::nexus { '/tmp/jtstand-ui-0.98.jar':
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	675 url => 'https://oss.sonatype.org',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	676 gav => 'org.codehaus.jtstand:jtstand-ui:0.98',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	677 repository => 'codehaus-releases',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	678 packaging => 'jar',
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	679 extract => false,
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	680 }
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	681
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	682 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	683
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	684 The following parameters are available in the `archive::nexus` defined type:
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	685
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	686 * [`url`](#url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	687 * [`gav`](#gav)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	688 * [`repository`](#repository)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	689 * [`ensure`](#ensure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	690 * [`checksum_type`](#checksum_type)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	691 * [`checksum_verify`](#checksum_verify)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	692 * [`packaging`](#packaging)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	693 * [`use_nexus3_urls`](#use_nexus3_urls)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	694 * [`classifier`](#classifier)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	695 * [`extension`](#extension)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	696 * [`username`](#username)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	697 * [`password`](#password)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	698 * [`user`](#user)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	699 * [`owner`](#owner)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	700 * [`group`](#group)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	701 * [`mode`](#mode)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	702 * [`extract`](#extract)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	703 * [`extract_path`](#extract_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	704 * [`extract_flags`](#extract_flags)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	705 * [`extract_command`](#extract_command)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	706 * [`creates`](#creates)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	707 * [`cleanup`](#cleanup)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	708 * [`proxy_server`](#proxy_server)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	709 * [`proxy_type`](#proxy_type)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	710 * [`allow_insecure`](#allow_insecure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	711 * [`temp_dir`](#temp_dir)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	712
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	713 ##### <a name="url"></a>`url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	714
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	715 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	716
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	717
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	718
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	719 ##### <a name="gav"></a>`gav`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	720
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	721 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	722
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	723
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	724
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	725 ##### <a name="repository"></a>`repository`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	726
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	727 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	728
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	729
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	730
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	731 ##### <a name="ensure"></a>`ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	732
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	733 Data type: `Enum['present', 'absent']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	734
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	735
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	736
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	737 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	738
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	739 ##### <a name="checksum_type"></a>`checksum_type`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	740
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	741 Data type: `Enum['none', 'md5', 'sha1', 'sha2','sha256', 'sha384', 'sha512']`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	742
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	743
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	744
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	745 Default value: `'md5'`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	746
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	747 ##### <a name="checksum_verify"></a>`checksum_verify`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	748
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	749 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	750
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	751
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	752
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	753 Default value: ``true``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	754
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	755 ##### <a name="packaging"></a>`packaging`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	756
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	757 Data type: `String`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	758
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	759
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	760
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	761 Default value: `'jar'`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	762
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	763 ##### <a name="use_nexus3_urls"></a>`use_nexus3_urls`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	764
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	765 Data type: `Boolean`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	766
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	767
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	768
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	769 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	770
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	771 ##### <a name="classifier"></a>`classifier`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	772
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	773 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	774
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	775
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	776
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	777 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	778
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	779 ##### <a name="extension"></a>`extension`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	780
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	781 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	782
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	783
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	784
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	785 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	786
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	787 ##### <a name="username"></a>`username`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	788
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	789 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	790
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	791
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	792
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	793 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	794
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	795 ##### <a name="password"></a>`password`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	796
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	797 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	798
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	799
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	800
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	801 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	802
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	803 ##### <a name="user"></a>`user`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	804
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	805 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	806
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	807
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	808
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	809 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	810
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	811 ##### <a name="owner"></a>`owner`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	812
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	813 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	814
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	815
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	816
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	817 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	818
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	819 ##### <a name="group"></a>`group`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	820
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	821 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	822
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	823
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	824
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	825 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	826
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	827 ##### <a name="mode"></a>`mode`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	828
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	829 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	830
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	831
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	832
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	833 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	834
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	835 ##### <a name="extract"></a>`extract`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	836
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	837 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	838
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	839
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	840
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	841 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	842
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	843 ##### <a name="extract_path"></a>`extract_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	844
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	845 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	846
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	847
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	848
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	849 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	850
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	851 ##### <a name="extract_flags"></a>`extract_flags`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	852
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	853 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	854
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	855
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	856
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	857 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	858
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	859 ##### <a name="extract_command"></a>`extract_command`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	860
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	861 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	862
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	863
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	864
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	865 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	866
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	867 ##### <a name="creates"></a>`creates`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	868
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	869 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	870
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	871
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	872
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	873 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	874
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	875 ##### <a name="cleanup"></a>`cleanup`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	876
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	877 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	878
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	879
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	880
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	881 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	882
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	883 ##### <a name="proxy_server"></a>`proxy_server`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	884
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	885 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	886
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	887
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	888
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	889 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	890
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	891 ##### <a name="proxy_type"></a>`proxy_type`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	892
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	893 Data type: `Optional[String]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	894
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	895
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	896
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	897 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	898
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	899 ##### <a name="allow_insecure"></a>`allow_insecure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	900
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	901 Data type: `Optional[Boolean]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	902
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	903
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	904
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	905 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	906
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	907 ##### <a name="temp_dir"></a>`temp_dir`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	908
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	909 Data type: `Optional[Stdlib::Absolutepath]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	910
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	911
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	912
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	913 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	914
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	915 ## Resource types
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	916
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	917 ### <a name="archive"></a>`archive`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	918
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	919 Manage archive file download, extraction, and cleanup.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	920
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	921 #### Properties
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	922
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	923 The following properties are available in the `archive` type.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	924
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	925 ##### `creates`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	926
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	927 if file/directory exists, will not download/extract archive.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	928
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	929 ##### `ensure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	930
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	931 Valid values: `present`, `absent`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	932
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	933 whether archive file should be present/absent (default: present)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	934
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	935 Default value: `present`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	936
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	937 #### Parameters
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	938
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	939 The following parameters are available in the `archive` type.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	940
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	941 * [`allow_insecure`](#allow_insecure)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	942 * [`checksum`](#checksum)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	943 * [`checksum_type`](#checksum_type)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	944 * [`checksum_url`](#checksum_url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	945 * [`checksum_verify`](#checksum_verify)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	946 * [`cleanup`](#cleanup)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	947 * [`cookie`](#cookie)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	948 * [`digest_string`](#digest_string)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	949 * [`digest_type`](#digest_type)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	950 * [`digest_url`](#digest_url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	951 * [`download_options`](#download_options)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	952 * [`extract`](#extract)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	953 * [`extract_command`](#extract_command)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	954 * [`extract_flags`](#extract_flags)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	955 * [`extract_path`](#extract_path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	956 * [`filename`](#filename)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	957 * [`group`](#group)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	958 * [`password`](#password)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	959 * [`path`](#path)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	960 * [`provider`](#provider)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	961 * [`proxy_server`](#proxy_server)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	962 * [`proxy_type`](#proxy_type)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	963 * [`source`](#source)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	964 * [`target`](#target)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	965 * [`temp_dir`](#temp_dir)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	966 * [`url`](#url)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	967 * [`user`](#user)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	968 * [`username`](#username)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	969
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	970 ##### <a name="allow_insecure"></a>`allow_insecure`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	971
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	972 Valid values: ``true``, ``false``, `yes`, `no`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	973
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	974 ignore HTTPS certificate errors
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	975
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	976 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	977
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	978 ##### <a name="checksum"></a>`checksum`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	979
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	980 Valid values: `%r{\b[0-9a-f]{5,128}\b}`, ``true``, ``false``, ``undef``, `nil`, `''`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	981
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	982 archive file checksum (match checksum_type).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	983
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	984 ##### <a name="checksum_type"></a>`checksum_type`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	985
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	986 Valid values: `none`, `md5`, `sha1`, `sha2`, `sha256`, `sha384`, `sha512`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	987
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	988 archive file checksum type (none\|md5\|sha1\|sha2\|sha256\|sha384\|sha512).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	989
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	990 Default value: `none`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	991
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	992 ##### <a name="checksum_url"></a>`checksum_url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	993
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	994 archive file checksum source (instead of specifying checksum)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	995
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	996 ##### <a name="checksum_verify"></a>`checksum_verify`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	997
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	998 Valid values: ``true``, ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	999
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1000 whether checksum wil be verified (true\|false).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1001
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1002 Default value: ``true``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1003
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1004 ##### <a name="cleanup"></a>`cleanup`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1005
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1006 Valid values: ``true``, ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1007
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1008 whether archive file will be removed after extraction (true\|false).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1009
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1010 Default value: ``true``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1011
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1012 ##### <a name="cookie"></a>`cookie`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1013
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1014 archive file download cookie.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1015
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1016 ##### <a name="digest_string"></a>`digest_string`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1017
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1018 Valid values: `%r{\b[0-9a-f]{5,128}\b}`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1019
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1020 archive file checksum (match checksum_type)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1021 (this parameter is for camptocamp/archive compatibility).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1022
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1023 ##### <a name="digest_type"></a>`digest_type`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1024
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1025 Valid values: `none`, `md5`, `sha1`, `sha2`, `sha256`, `sha384`, `sha512`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1026
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1027 archive file checksum type (none\|md5\|sha1\|sha2\|sha256\|sha384\|sha512)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1028 (this parameter is camptocamp/archive compatibility).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1029
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1030 ##### <a name="digest_url"></a>`digest_url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1031
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1032 archive file checksum source (instead of specifying checksum)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1033 (this parameter is for camptocamp/archive compatibility)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1034
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1035 ##### <a name="download_options"></a>`download_options`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1036
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1037 provider download options (affects curl, wget, gs, and only s3 downloads for ruby provider)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1038
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1039 ##### <a name="extract"></a>`extract`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1040
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1041 Valid values: ``true``, ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1042
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1043 whether archive will be extracted after download (true\|false).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1044
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1045 Default value: ``false``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1046
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1047 ##### <a name="extract_command"></a>`extract_command`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1048
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1049 custom extraction command ('tar xvf example.tar.gz'), also support sprintf format ('tar xvf %s') which will be processed
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1050 with the filename: sprintf('tar xvf %s', filename)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1051
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1052 ##### <a name="extract_flags"></a>`extract_flags`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1053
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1054 custom extraction options, this replaces the default flags. A string such as 'xvf' for a tar file would replace the
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1055 default xf flag. A hash is useful when custom flags are needed for different platforms. {'tar' => 'xzf', '7z' => 'x
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1056 -aot'}.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1057
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1058 Default value: ``undef``
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1059
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1060 ##### <a name="extract_path"></a>`extract_path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1061
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1062 target folder path to extract archive.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1063
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1064 ##### <a name="filename"></a>`filename`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1065
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1066 archive file name (derived from path).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1067
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1068 ##### <a name="group"></a>`group`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1069
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1070 extract command group (using this option will configure the archive file permisison to 0644 so the user can read the
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1071 file).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1072
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1073 ##### <a name="password"></a>`password`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1074
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1075 password to download source file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1076
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1077 ##### <a name="path"></a>`path`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1078
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1079 namevar, archive file fully qualified file path.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1080
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1081 ##### <a name="provider"></a>`provider`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1082
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1083 The specific backend to use for this `archive` resource. You will seldom need to specify this --- Puppet will usually
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1084 discover the appropriate provider for your platform.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1085
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1086 ##### <a name="proxy_server"></a>`proxy_server`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1087
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1088 proxy address to use when accessing source
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1089
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1090 ##### <a name="proxy_type"></a>`proxy_type`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1091
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1092 Valid values: `none`, `ftp`, `http`, `https`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1093
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1094 proxy type (none\|ftp\|http\|https)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1095
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1096 ##### <a name="source"></a>`source`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1097
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1098 archive file source, supports puppet\|http\|https\|ftp\|file\|s3\|gs uri.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1099
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1100 ##### <a name="target"></a>`target`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1101
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1102 target folder path to extract archive. (this parameter is for camptocamp/archive compatibility)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1103
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1104 ##### <a name="temp_dir"></a>`temp_dir`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1105
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1106 Specify an alternative temporary directory to use for copying files, if unset then the operating system default will be
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1107 used.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1108
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1109 ##### <a name="url"></a>`url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1110
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1111 archive file source, supports http\|https\|ftp\|file uri.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1112 (for camptocamp/archive compatibility)
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1113
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1114 ##### <a name="user"></a>`user`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1115
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1116 extract command user (using this option will configure the archive file permission to 0644 so the user can read the
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1117 file).
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1118
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1119 ##### <a name="username"></a>`username`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1120
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1121 username to download source file.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1122
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1123 ## Functions
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1124
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1125 ### <a name="archiveartifactory_checksum"></a>`archive::artifactory_checksum`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1126
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1127 Type: Ruby 4.x API
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1128
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1129 A function that returns the checksum value of an artifact stored in Artifactory
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1130
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1131 #### `archive::artifactory_checksum(Stdlib::HTTPUrl $url, Optional[Enum['sha1','sha256','md5']] $checksum_type)`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1132
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1133 The archive::artifactory_checksum function.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1134
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1135 Returns: `String` Returns the checksum.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1136
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1137 ##### `url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1138
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1139 Data type: `Stdlib::HTTPUrl`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1140
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1141 The URL of the artifact.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1142
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1143 ##### `checksum_type`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1144
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1145 Data type: `Optional[Enum['sha1','sha256','md5']]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1146
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1147 The checksum type.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1148 Note the function will raise an error if you ask for sha256 but your artifactory instance doesn't have the sha256 value calculated.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1149
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1150 ### <a name="archiveartifactory_latest_url"></a>`archive::artifactory_latest_url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1151
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1152 Type: Ruby 4.x API
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1153
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1154 The archive::artifactory_latest_url function.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1155
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1156 #### `archive::artifactory_latest_url(Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl] $url, Hash $maven_data)`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1157
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1158 The archive::artifactory_latest_url function.
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1159
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1160 Returns: `Any`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1161
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1162 ##### `url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1163
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1164 Data type: `Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1165
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1166
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1167
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1168 ##### `maven_data`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1169
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1170 Data type: `Hash`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1171
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1172
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1173
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1174 ### <a name="archiveparse_artifactory_url"></a>`archive::parse_artifactory_url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1175
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1176 Type: Ruby 4.x API
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1177
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1178 A function to parse an Artifactory maven 2 repository URL
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1179
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1180 #### `archive::parse_artifactory_url(Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl] $url)`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1181
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1182 A function to parse an Artifactory maven 2 repository URL
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1183
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1184 Returns: `Any`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1185
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1186 ##### `url`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1187
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1188 Data type: `Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl]`
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1189
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1190
3fce34f642f1 Add a PHP module to handle platform differences IBBoard <dev@ibboard.co.uk> parents: diff changeset	1191

Mercurial > repos > other > Puppet

annotate modules/archive/REFERENCE.md @ 454:d0e7979c7e8c