Skip to content

Commit e1384b4

Browse files
david-brettdavid-brett
authored
Merge pull request #4 from dbretty/v2308.001_Initial_Cut
New-CitrixTemplateReport
2 parents bd0e656 + a76a06b commit e1384b4

6 files changed

Lines changed: 335 additions & 3 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# Local Testing for XML File Generation and Local PS1 File Testing
44
*.xml
55
*.ps1
6+
REPORT.MD
67

78
#VSCode
89

@@ -47,4 +48,5 @@ Icon
4748
.AppleDesktop
4849
Network Trash Folder
4950
Temporary Items
50-
.apdisk
51+
.apdisk
52+

‎CitrixOptimizerAutomation/CitrixOptimizerAutomation.psd1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
RootModule = 'CitrixOptimizerAutomation.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '2307.005'
15+
ModuleVersion = '2307.006'
1616

1717
# Supported PSEditions
1818
# CompatiblePSEditions = @()
@@ -69,7 +69,7 @@ PowerShellVersion = '5.1'
6969
# NestedModules = @()
7070

7171
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
72-
FunctionsToExport = @('New-CitrixTemplate', 'New-CitrixTemplateGroup', 'New-CitrixTemplateService', 'New-CitrixTemplateTask', 'New-CitrixTemplateRegistry', 'New-CitrixTemplateScript')
72+
FunctionsToExport = @('New-CitrixTemplate', 'New-CitrixTemplateGroup', 'New-CitrixTemplateService', 'New-CitrixTemplateTask', 'New-CitrixTemplateRegistry', 'New-CitrixTemplateScript', 'Get-CitrixTemplate', 'Get-CitrixTemplateGroup', 'Get-CitrixTemplateEntry', 'New-CitrixTemplateReport')
7373

7474
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
7575
CmdletsToExport = @()

‎Help/Get-CitrixTemplate.MD‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Get-CitrixTemplate
2+
3+
Gets a Citrix Optimizer Template.
4+
5+
## Syntax
6+
7+
```PowerShell
8+
Get-CitrixTemplate
9+
[-Path] <String[]>
10+
[<CommonParameters>]
11+
```
12+
## Description
13+
14+
This function will get a Citrix Optimizer Template and return the Template Path and Template Contents.
15+
16+
## Examples
17+
18+
### Example 1
19+
20+
```PowerShell
21+
Get-CitrixTemplate -Path 'template.xml'
22+
```
23+
24+
Gets 'template.xml' and returns the XML as part of the Object'.
25+
26+
## Parameters
27+
28+
### -Path
29+
30+
Specifies the Path for the Citrix Optimizer Template
31+
32+
| Description | Option |
33+
|:---|:---|
34+
| Type | String |
35+
| Mandatory | True |
36+
| Default Value | None |
37+
| Accept pipeline input | True |
38+
| Accept wildcard characters | False |

‎Help/Get-CitrixTemplateEntry.MD‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Get-CitrixTemplateEntry
2+
3+
Gets Entries from the Citrix Optimizer template.
4+
5+
## Syntax
6+
7+
```PowerShell
8+
Get-CitrixTemplateEntry
9+
[-Path] <String[]>
10+
[-EntryName] <String[]>
11+
[-Registry] <Switch[]>
12+
[-ScheduledTask] <Switch[]>
13+
[-Service] <Switch[]>
14+
[-PowerShell] <Switch[]>
15+
[<CommonParameters>]
16+
```
17+
## Description
18+
19+
This function will get the Entries from a Citrix Optimizer Template passed in
20+
21+
## Examples
22+
23+
### Example 1
24+
25+
```PowerShell
26+
Get-CitrixTemplateEntry -Path 'template.xml' -EntryName "Optimize Internet Explorer"
27+
```
28+
29+
Gets the entry details for the entry "Optimize Internet Explorer".
30+
31+
### Example 2
32+
33+
```PowerShell
34+
Get-CitrixTemplateEntry -Path 'template.xml' -Registry
35+
```
36+
37+
Gets all the Registry Entries from the Template File.
38+
39+
### Example 3
40+
41+
```PowerShell
42+
$Entries = Get-CitrixTemplateEntry -Path 'template.xml' -Service
43+
```
44+
45+
Gets all the Service Entries from the template and assigns the result to the $Entries variable.
46+
47+
## Parameters
48+
49+
### -Path
50+
51+
Specifies the Path and Name for the Citrix Optimizer Template
52+
53+
| Description | Option |
54+
|:---|:---|
55+
| Type | String |
56+
| Mandatory | True |
57+
| Default Value: | None |
58+
| Accept pipeline input: | True |
59+
| Accept wildcard characters: | False |
60+
61+
### -EntryName
62+
63+
Specifies the Entry Name
64+
65+
| Description | Option |
66+
|:---|:---|
67+
| Type | String |
68+
| Mandatory | False |
69+
| Default Value: | None |
70+
| Accept pipeline input: | True |
71+
| Accept wildcard characters: | False |
72+
73+
### -Registry
74+
75+
Switch for Registry
76+
77+
| Description | Option |
78+
|:---|:---|
79+
| Type | Switch |
80+
| Mandatory | False |
81+
| Default Value: | None |
82+
| Accept pipeline input: | True |
83+
| Accept wildcard characters: | False |
84+
85+
### -ScheduledTask
86+
87+
Switch for ScheduledTask
88+
89+
| Description | Option |
90+
|:---|:---|
91+
| Type | Switch |
92+
| Mandatory | False |
93+
| Default Value: | None |
94+
| Accept pipeline input: | True |
95+
| Accept wildcard characters: | False |
96+
97+
### -Service
98+
99+
Switch for Service
100+
101+
| Description | Option |
102+
|:---|:---|
103+
| Type | Switch |
104+
| Mandatory | False |
105+
| Default Value: | None |
106+
| Accept pipeline input: | True |
107+
| Accept wildcard characters: | False |
108+
109+
### -PowerShell
110+
111+
Switch for PowerShell
112+
113+
| Description | Option |
114+
|:---|:---|
115+
| Type | Switch |
116+
| Mandatory | False |
117+
| Default Value: | None |
118+
| Accept pipeline input: | True |
119+
| Accept wildcard characters: | False |

‎Help/Get-CitrixTemplateGroup.MD‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Get-CitrixTemplateGroup
2+
3+
Gets Group Entries from the Citrix Optimizer template.
4+
5+
## Syntax
6+
7+
```PowerShell
8+
Get-CitrixTemplate
9+
[-Path] <String[]>
10+
[-GroupName] <String[]>
11+
[<CommonParameters>]
12+
```
13+
## Description
14+
15+
This function will get the Group Entries from a Citrix Optimizer Template passed in
16+
17+
## Examples
18+
19+
### Example 1
20+
21+
```PowerShell
22+
Get-CitrixTemplateGroup -Path 'template.xml' -GroupName 'OS Optimizations'
23+
```
24+
25+
Gets the Group called "OS Optimizations"
26+
27+
### Example 2
28+
29+
```PowerShell
30+
Get-CitrixTemplateGroup -Path $Template.Path -GroupName 'System Optimizations'
31+
```
32+
33+
Gets the Group called "System Optimizations" in the template file based on the result of a New-CitrixTemplate return object.
34+
35+
### Example 3
36+
37+
```PowerShell
38+
$Group = Get-CitrixTemplateGroup -Path $Template.Path -GroupName 'System Optimizations'
39+
```
40+
41+
Gets the Group called "System Optimizations" in the template file based on the result of a New-CitrixTemplate return object and pipes this into the variable $Group.
42+
43+
## Parameters
44+
45+
### -Path
46+
47+
Specifies the Path and Name for the Citrix Optimizer Template
48+
49+
| Description | Option |
50+
|:---|:---|
51+
| Type | String |
52+
| Mandatory | True |
53+
| Default Value: | None |
54+
| Accept pipeline input: | True |
55+
| Accept wildcard characters: | False |
56+
57+
### -GroupName
58+
59+
Specifies the Group Name to add
60+
61+
| Description | Option |
62+
|:---|:---|
63+
| Type | String |
64+
| Mandatory | True |
65+
| Default Value: | None |
66+
| Accept pipeline input: | True |
67+
| Accept wildcard characters: | False |

‎Help/New-CitrixTemplateReport.MD‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# New-CitrixTemplateReport
2+
3+
Creates a new Citrix Optimizer Template report.
4+
5+
## Syntax
6+
7+
```PowerShell
8+
New-CitrixTemplateReport
9+
[-Path] <String[]>
10+
[-Registry] <Switch[]>
11+
[-ScheduledTask] <Switch[]>
12+
[-Service] <Switch[]>
13+
[-PowerShell] <Switch[]>
14+
[<CommonParameters>]
15+
```
16+
## Description
17+
18+
This function will create a markdown report based on the template passed in.
19+
20+
## Examples
21+
22+
### Example 1
23+
24+
```PowerShell
25+
New-CitrixTemplateReport -Path 'template.xml'
26+
```
27+
28+
Creates a new report from the template.xml file
29+
30+
### Example 2
31+
32+
```PowerShell
33+
New-CitrixTemplateReport -Path 'template.xml' -Registry
34+
```
35+
36+
Creates a new report from the template.xml file with only the Registry entries present.
37+
38+
### Example 3
39+
40+
```PowerShell
41+
New-CitrixTemplateReport -Path 'template.xml' -Registry -Service
42+
```
43+
44+
Creates a new report from the template.xml file with the Registry and Service entries present.
45+
46+
## Parameters
47+
48+
### -Path
49+
50+
Specifies the Path and Name for the Citrix Optimizer Template
51+
52+
| Description | Option |
53+
|:---|:---|
54+
| Type | String |
55+
| Mandatory | True |
56+
| Default Value: | None |
57+
| Accept pipeline input: | True |
58+
| Accept wildcard characters: | False |
59+
60+
### -Registry
61+
62+
Switch for Registry
63+
64+
| Description | Option |
65+
|:---|:---|
66+
| Type | Switch |
67+
| Mandatory | False |
68+
| Default Value: | None |
69+
| Accept pipeline input: | True |
70+
| Accept wildcard characters: | False |
71+
72+
### -ScheduledTask
73+
74+
Switch for ScheduledTask
75+
76+
| Description | Option |
77+
|:---|:---|
78+
| Type | Switch |
79+
| Mandatory | False |
80+
| Default Value: | None |
81+
| Accept pipeline input: | True |
82+
| Accept wildcard characters: | False |
83+
84+
### -Service
85+
86+
Switch for Service
87+
88+
| Description | Option |
89+
|:---|:---|
90+
| Type | Switch |
91+
| Mandatory | False |
92+
| Default Value: | None |
93+
| Accept pipeline input: | True |
94+
| Accept wildcard characters: | False |
95+
96+
### -PowerShell
97+
98+
Switch for PowerShell
99+
100+
| Description | Option |
101+
|:---|:---|
102+
| Type | Switch |
103+
| Mandatory | False |
104+
| Default Value: | None |
105+
| Accept pipeline input: | True |
106+
| Accept wildcard characters: | False |

0 commit comments

Comments
 (0)