├── .gitignore ├── Documentation └── Function │ ├── Get-ICXInterface.README.md │ ├── Get-ICXSession.README.md │ ├── Get-ICXVLAN.README.md │ ├── Images │ ├── Get-ICXInterface.png │ ├── Get-ICXSession.png │ ├── Get-ICXVLAN.png │ ├── Invoke-ICXCommand.png │ ├── New-ICXSession.png │ ├── Remove-ICXSession.png │ ├── Test-ICXSession.png │ ├── Test-ICXVLAN.png │ └── Thumbs.db │ ├── Invoke-ICXCommand.README.md │ ├── New-ICXSession.README.md │ ├── Remove-ICXSession.README.md │ ├── Test-ICXSession.README.md │ └── Test-ICXVLAN.README.md ├── LICENSE ├── Module └── BrocadeICX │ ├── BrocadeICX.psd1 │ ├── BrocadeICX.psm1 │ ├── Core │ ├── Get-ICXSession.ps1 │ ├── Invoke-ICXCommand.ps1 │ ├── New-ICXSession.ps1 │ ├── Remove-ICXSession.ps1 │ └── Test-ICXSession.ps1 │ └── Functions │ ├── Interface │ └── Get-ICXInterface.ps1 │ └── VLAN │ ├── Get-ICXVLAN.ps1 │ └── Test-ICXVLAN.ps1 └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | Documentation/Function/Images/Thumbs.db 2 | \_*.ps1 -------------------------------------------------------------------------------- /Documentation/Function/Get-ICXInterface.README.md: -------------------------------------------------------------------------------- 1 | # Get-ICXInterface 2 | 3 | Get interface(s) from a Brocade ICX Switch. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Functions/Interface/Get-ICXInterface.ps1) 6 | 7 | ## Description 8 | 9 | Get interface(s) from a Brocade ICX Switch with status [up|down], speed [1G|100M|10M] etc. 10 | 11 | ![Screenshot](Images/Get-ICXInterface.png?raw=true) 12 | 13 | ## Syntax 14 | 15 | ```powershell 16 | Get-ICXInterface [-ComputerName] [[-AcceptKey]] [[-Credential] ] [] 17 | 18 | Get-ICXInterface [-Session] [] 19 | ``` 20 | 21 | ## Example 1 22 | 23 | ```powershell 24 | PS> Get-ICXInterface -ComputerName megatron | Select-Object -First 5 | Format-Table 25 | 26 | Port Link State Duplex Speed Trunk Tag Pvid Priority MAC Name 27 | ---- ---- ----- ------ ----- ----- --- ---- -------- --- ---- 28 | 0/1/1 Up Forward Full 1G None Yes N/A 0 0000.0000.0000 UPLINK 29 | 0/1/2 Up Forward Full 1G None No 1001 0 0000.0000.0001 30 | 0/1/3 Up Forward Full 100M None No 1001 0 0000.0000.0002 31 | 0/1/4 Down None None None None No 1 0 0000.0000.0003 32 | 0/1/5 Up Forward Full 1G None No 1001 0 0000.0000.0004 33 | ``` 34 | 35 | ## Example 2 36 | 37 | ```powershell 38 | PS> $Sessions = New-ICXSession -ComputerName MEGATRON, megatron 39 | PS> Get-ICXInterface -Session $Sessions | Format-Table 40 | 41 | SessionID ComputerName Port Link State Duplex Speed Trunk Tag Pvid Priority MAC Name 42 | --------- ------------ ---- ---- ----- ------ ----- ----- --- ---- -------- --- ---- 43 | 0 megatron 0/1/1 Up Forward Full 1G None Yes N/A 0 0000.0000.0000 UPLINK 44 | 0 megatron 0/1/2 Up Forward Full 1G None No 1001 0 0000.0000.0001 45 | 0 megatron 0/1/3 Up Forward Full 100M None No 1001 0 0000.0000.0002 46 | 0 megatron 0/1/4 Down None None None None No 1 0 0000.0000.0003 47 | 0 megatron 0/1/5 Up Forward Full 1G None No 1001 0 0000.0000.0004 48 | ... 49 | 1 MEGATRON 0/1/1 Up Forward Full 1G None Yes N/A 0 0000.0000.0000 UPLINK 50 | 1 MEGATRON 0/1/2 Up Forward Full 1G None No 1001 0 0000.0000.0001 51 | 1 MEGATRON 0/1/3 Up Forward Full 100M None No 1001 0 0000.0000.0002 52 | 1 MEGATRON 0/1/4 Down None None None None No 1 0 0000.0000.0003 53 | 1 MEGATRON 0/1/5 Up Forward Full 1G None No 1001 0 0000.0000.0004 54 | ... 55 | ``` -------------------------------------------------------------------------------- /Documentation/Function/Get-ICXSession.README.md: -------------------------------------------------------------------------------- 1 | # Get-ICXSession 2 | 3 | Get a Brocade ICX session. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Core/Get-ICXSession.ps1) 6 | 7 | ## Description 8 | 9 | Get one or multiple Brocade ICX sessions based on SessionID or ComputerName. 10 | 11 | ![Screenshot](Images/Get-ICXSession.png?raw=true) 12 | 13 | ## Syntax 14 | 15 | ```powershell 16 | Get-ICXSession [] 17 | 18 | Get-ICXSession [-SessionID] [] 19 | 20 | Get-ICXSession [-ComputerName] [[-CaseSensitive]] [] 21 | ``` 22 | 23 | ## Example 1 24 | 25 | ```powershell 26 | PS> Get-ICXSession -SessionID 1, 2 27 | 28 | SessionID ComputerName AccessMode 29 | --------- ------------ ---------- 30 | 1 MEGATRON Privileged 31 | 2 megatron Config 32 | ``` 33 | 34 | ## Example 2 35 | 36 | ```powershell 37 | PS> Get-ICXSession -ComputerName MEGATRON | Select-Object * | Format-Table 38 | 39 | SessionID ComputerName AccessMode Session Stream 40 | --------- ------------ ---------- ------- ------ 41 | 0 megatron Privileged SSH.SshSession Renci.SshNet.ShellStream 42 | 1 MEGATRON Privileged SSH.SshSession Renci.SshNet.ShellStream 43 | 2 megatron Config SSH.SshSession Renci.SshNet.ShellStream 44 | ``` 45 | 46 | ## Example 3 47 | 48 | ```powershell 49 | PS> Get-ICXSession -ComputerName MEGATRON -CaseSensitive 50 | 51 | SessionID ComputerName AccessMode 52 | --------- ------------ ---------- 53 | 1 MEGATRON Privileged 54 | ``` -------------------------------------------------------------------------------- /Documentation/Function/Get-ICXVLAN.README.md: -------------------------------------------------------------------------------- 1 | # Get-ICXVLAN 2 | 3 | Get VLAN(s) from a Brocade ICX Switch. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Functions/VLAN/Get-ICXVLAN.ps1) 6 | 7 | ## Description 8 | 9 | Get VLAN(s) from a Brocade ICX Switch as PSCustomObject, which can be further processed. 10 | 11 | ![Screenshot](Images/Get-ICXVLAN.png?raw=true) 12 | 13 | ## Syntax 14 | 15 | ```powershell 16 | Get-ICXVLAN [-ComputerName] [[-AcceptKey]] [[-Credential] ] [] 17 | 18 | Get-ICXVLAN [-Session] [] 19 | ``` 20 | 21 | ## Example 1 22 | 23 | ```powershell 24 | PS> Get-ICXVLAN -ComputerName megatron | ? {$_.Name -eq "Test1"} | ft 25 | 26 | ID Name By TaggedPort UntaggedPort 27 | -- ---- -- ---------- ------------ 28 | 1001 Test1 port {0/1/4} {0/1/37, 0/1/39, 0/1/45, 0/1/46} 29 | ``` 30 | 31 | ## Example 2 32 | 33 | ```powershell 34 | PS> New-ICXSession -ComputerName MEGATRON, megatron 35 | PS> Get-ICXVLAN -Session (Get-ICXSession) | ? {$_.Name -eq "Test1"} | ft 36 | 37 | SessionID ComputerName ID Name By TaggedPort UntaggedPort 38 | --------- ------------ -- ---- -- ---------- ------------ 39 | 0 MEGATRON 1001 Test1 port {0/1/4} {0/1/37, 0/1/39, 0/1/45, 0/1/46} 40 | 1 megatron 1001 Test1 port {0/1/4} {0/1/37, 0/1/39, 0/1/45, 0/1/46} 41 | ``` -------------------------------------------------------------------------------- /Documentation/Function/Images/Get-ICXInterface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Get-ICXInterface.png -------------------------------------------------------------------------------- /Documentation/Function/Images/Get-ICXSession.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Get-ICXSession.png -------------------------------------------------------------------------------- /Documentation/Function/Images/Get-ICXVLAN.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Get-ICXVLAN.png -------------------------------------------------------------------------------- /Documentation/Function/Images/Invoke-ICXCommand.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Invoke-ICXCommand.png -------------------------------------------------------------------------------- /Documentation/Function/Images/New-ICXSession.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/New-ICXSession.png -------------------------------------------------------------------------------- /Documentation/Function/Images/Remove-ICXSession.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Remove-ICXSession.png -------------------------------------------------------------------------------- /Documentation/Function/Images/Test-ICXSession.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Test-ICXSession.png -------------------------------------------------------------------------------- /Documentation/Function/Images/Test-ICXVLAN.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Test-ICXVLAN.png -------------------------------------------------------------------------------- /Documentation/Function/Images/Thumbs.db: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Documentation/Function/Images/Thumbs.db -------------------------------------------------------------------------------- /Documentation/Function/Invoke-ICXCommand.README.md: -------------------------------------------------------------------------------- 1 | # Invoke-ICXCommand 2 | 3 | Invoke an SSH command in a Brocade ICX session. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Core/Invoke-ICXCommand.ps1) 6 | 7 | ## Description 8 | 9 | Invoke an SSH command into one or multiple Brocade ICX session(s). By default, the function will try to detect the SSH output automatically based on the first and last string. Normally the output starts with the SSH command (which was passed) and ends with SSH@HOSTNAME#. If the automatic detection fails and the timeout is reached, the output which is currently in the SSH stream will be returned. 10 | 11 | If you have trouble with some commands (such as `copy running-config tftp ...`), you should try the compatibility mode (`-CompatibilityMode`) and define your own timout values (`-Seconds` or `-Milliseconds`). With the compatibility mode, the SSH command ist executed and the output of the SSH stream is returned after a specific time. Or if you know the endstring(s) of the output, you can use the parameter `-EndString` to overwrite the default. 12 | 13 | ![Screenshot](Images/Invoke-ICXCommand.png?raw=true) 14 | 15 | ## Syntax 16 | 17 | ```powershell 18 | Invoke-ICXCommand [-Command] [-Session] [[-Timeout] ] [[-EndString] ] [] 19 | 20 | Invoke-ICXCommand [-Command] [-Session] [[-CompatibilityMode]] [[-Seconds] ] [] 21 | 22 | Invoke-ICXCommand [-Command] [-Session] [[-CompatibilityMode]] [[-Milliseconds] ] [] 23 | ``` 24 | 25 | ## Example 1 26 | 27 | ```powershell 28 | PS> Get-ICXSession | Invoke-ICXCommand -Command "sh clock" 29 | 30 | SessionID ComputerName Output 31 | --------- ------------ ------ 32 | 0 megatron {14:53:53 GMT+01 Thu Aug 25 2016... 33 | 1 megaTRON {14:53:53 GMT+01 Thu Aug 25 2016... 34 | 2 megatron {14:53:53 GMT+01 Thu Aug 25 2016... 35 | ``` 36 | 37 | ## Example 2 38 | 39 | ```powershell 40 | PS> $Session = Get-ICXSession -SessionID 0 41 | PS> (Invoke-ICXCommand -Command "sh clock" -Session $Session).Output 42 | 43 | 14:54:13 GMT+01 Thu Aug 25 2016 44 | ``` 45 | 46 | ## Example 3 47 | ```powershell 48 | PS> (Get-ICXSession -SessionID 2 | Invoke-ICXCommand -Command "copy running-config tftp 192.168.XXX.XXX" -CompatibilityMode -Seconds 5).Output 49 | 50 | Upload running-config to TFTP server done. 51 | ``` -------------------------------------------------------------------------------- /Documentation/Function/New-ICXSession.README.md: -------------------------------------------------------------------------------- 1 | # New-ICXSession 2 | 3 | Create a new Brocade ICX sessions over SSH. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Core/New-ICXSession.ps1) 6 | 7 | ## Description 8 | 9 | Create one or multiple Brocade ICX session over SSH. If no credentials are submitted, a credential popup will appear. 10 | 11 | ![Screenshot](Images/New-ICXSession.png?raw=true) 12 | 13 | ## Syntax 14 | 15 | ```powershell 16 | New-ICXSession [-ComputerName] [[-AcceptKey]] [[-Credential] ] [] 17 | ``` 18 | 19 | ## Example 20 | 21 | ```powershell 22 | PS> New-ICXSession -ComputerName megatron 23 | 24 | SessionID ComputerName AccessMode 25 | --------- ------------ ---------- 26 | 0 megatron Privileged 27 | ``` -------------------------------------------------------------------------------- /Documentation/Function/Remove-ICXSession.README.md: -------------------------------------------------------------------------------- 1 | # Remove-ICXSession 2 | 3 | Remove a Brocade ICX session. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Core/Remove-ICXSession.ps1) 6 | 7 | ## Description 8 | 9 | Remove one or multiple Brocade ICX sessions. 10 | 11 | ![Screenshot](Images/Remove-ICXSession.png?raw=true) 12 | 13 | ## Syntax 14 | 15 | ```powershell 16 | Remove-ICXSession [-SessionID] [] 17 | 18 | Remove-ICXSession [-ComputerName] [[-CaseSensitive]] [] 19 | 20 | Remove-ICXSession [-Session] [] 21 | ``` 22 | 23 | ## Example 1 24 | 25 | ```powershell 26 | PS> Remove-ICXSession -SessionID 1 27 | ``` 28 | 29 | ## Example 2 30 | 31 | ```powershell 32 | PS> Get-ICXSession | Remove-ICXSession 33 | ``` 34 | 35 | ## Example 3 36 | ```powershell 37 | PS> Remove-ICXSession -ComputerName megatron 38 | ``` -------------------------------------------------------------------------------- /Documentation/Function/Test-ICXSession.README.md: -------------------------------------------------------------------------------- 1 | # Test-ICXSession 2 | 3 | Test if a session is a valid Brocade ICX session. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Core/Test-ICXSession.ps1) 6 | 7 | ## Description 8 | 9 | Test if a session is a valid Brocade ICX session and managed by the BrocadeICX module. 10 | 11 | ![Screenshot](Images/Test-ICXSession.png?raw=true) 12 | 13 | ## Syntax 14 | 15 | ```powershell 16 | Test-ICXSession [-Session] [] 17 | ``` 18 | 19 | ## Example 1 20 | 21 | ```powershell 22 | PS> $Session = Get-ICXSession -SessionID 0 23 | PS> Test-ICXSession -Session $Session 24 | 25 | true 26 | ``` 27 | 28 | ## Example 2 29 | 30 | ```powershell 31 | PS> "Test" | Test-ICXSessions 32 | 33 | false 34 | ``` 35 | -------------------------------------------------------------------------------- /Documentation/Function/Test-ICXVLAN.README.md: -------------------------------------------------------------------------------- 1 | # Test-ICXVLAN 2 | 3 | Test if a VLAN exist on a Brocade ICX Switch. 4 | 5 | * [view function](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Module/BrocadeICX/Functions/VLAN/Test-ICXVLAN.ps1) 6 | 7 | ## Description 8 | 9 | Test if a VLAN exist on a Brocade ICX Switch. 10 | 11 | ![Screenshot](Images/Test-ICXVLAN.png?raw=true) 12 | 13 | ## Syntax 14 | 15 | ```powershell 16 | Get-ICXVLAN [-ComputerName] [[-AcceptKey]] [[-Credential] ] [] 17 | 18 | Get-ICXVLAN [-Session] [] 19 | ``` 20 | 21 | ## Example 1 22 | 23 | ```powershell 24 | PS> Test-ICXVLAN -ComputerName megatron -VlanId 1 25 | 26 | true 27 | ``` 28 | 29 | ## Example 2 30 | 31 | ```powershell 32 | PS> $Cred = Get-Credential $null 33 | PS> Test-ICXVLAN -ComputerName megatron -VlanId 2 -Credential $Cred 34 | 35 | false 36 | ``` 37 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /Module/BrocadeICX/BrocadeICX.psd1: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BornToBeRoot/PowerShell_BrocadeICX/635241424638ce7ab37d36499fb9378cd5c0c2b8/Module/BrocadeICX/BrocadeICX.psd1 -------------------------------------------------------------------------------- /Module/BrocadeICX/BrocadeICX.psm1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : BrocadeICX.psm1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Module to administrate Brocade ICX Switches over SSH 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | # Global array to store Brocade ICX sessions 10 | if(-not(Test-Path Variable:BrocadeICXSessions)) 11 | { 12 | [System.Collections.ArrayList]$Global:BrocadeICXSessions = @() 13 | } 14 | 15 | # Import core functions 16 | Get-ChildItem -Path "$PSScriptRoot\Core" -Recurse | Where-Object {$_.Name.EndsWith(".ps1")} | ForEach-Object {. $_.FullName} 17 | 18 | # Import additional functions 19 | Get-ChildItem -Path "$PSScriptRoot\Functions" -Recurse | Where-Object {($_.Name.EndsWith(".ps1")) -and (-not($_.Name.StartsWith("_")))} | ForEach-Object {. $_.FullName} -------------------------------------------------------------------------------- /Module/BrocadeICX/Core/Get-ICXSession.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : Get-ICXSession.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Get a Brocade ICX session 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Get a Brocade ICX session 12 | 13 | .DESCRIPTION 14 | Get one or multiple Brocade ICX sessions based on SessionID or ComputerName. 15 | 16 | .EXAMPLE 17 | Get-ICXSession -SessionID 1, 2 18 | 19 | SessionID ComputerName AccessMode 20 | --------- ------------ ---------- 21 | 1 MEGATRON Privileged 22 | 2 megatron Config 23 | 24 | .EXAMPLE 25 | Get-ICXSession -ComputerName MEGATRON | Select-Object * | Format-Table 26 | 27 | SessionID ComputerName AccessMode Session Stream 28 | --------- ------------ ---------- ------- ------ 29 | 0 megatron Privileged SSH.SshSession Renci.SshNet.ShellStream 30 | 1 MEGATRON Privileged SSH.SshSession Renci.SshNet.ShellStream 31 | 2 megatron Config SSH.SshSession Renci.SshNet.ShellStream 32 | 33 | .EXAMPLE 34 | Get-ICXSession -ComputerName MEGATRON -CaseSensitive 35 | 36 | SessionID ComputerName AccessMode 37 | --------- ------------ ---------- 38 | 1 MEGATRON Privileged 39 | 40 | .LINK 41 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/Get-ICXSession.README.md 42 | #> 43 | 44 | function Get-ICXSession 45 | { 46 | [CmdletBinding(DefaultParameterSetName='__AllParameterSets')] 47 | param( 48 | [Parameter( 49 | ParameterSetName='SessionID', 50 | Position=0, 51 | Mandatory=$true, 52 | HelpMessage='ID of the Brocade ICX session')] 53 | [Int32[]]$SessionID, 54 | 55 | [Parameter( 56 | ParameterSetName='ComputerName', 57 | Position=0, 58 | Mandatory=$true, 59 | HelpMessage='ComputerName of the Brocade ICX session')] 60 | [String[]]$ComputerName, 61 | 62 | [Parameter( 63 | ParameterSetName='ComputerName', 64 | Position=1, 65 | HelpMessage='ComputerName must match exactly')] 66 | [switch]$CaseSensitive 67 | ) 68 | 69 | Begin{ 70 | 71 | } 72 | 73 | Process{ 74 | # Temporary array to store Brocade ICX sessions - This is necessary to prevent an enumeration error when removing sessions with the pipe 75 | $ICXSessions = @() 76 | 77 | # Switch between the different parameter sets 78 | switch($PSCmdlet.ParameterSetName) 79 | { 80 | "SessionID" { 81 | Write-Verbose -Message "Filter Brocade ICX sessions using the ID." 82 | 83 | foreach($SessionID2 in $SessionID) 84 | { 85 | foreach($ICXSession in $Global:BrocadeICXSessions) 86 | { 87 | if($ICXSession.SessionID -eq $SessionID2) 88 | { 89 | $ICXSessions += $ICXSession 90 | } 91 | } 92 | } 93 | } 94 | 95 | "ComputerName" { 96 | Write-Verbose -Message "Filter Brocade ICX sessions using the ComputerName." 97 | 98 | foreach($ComputerName2 in $ComputerName) 99 | { 100 | foreach($ICXSession in $Global:BrocadeICXSessions) 101 | { 102 | if((($CaseSensitive -eq $false) -and ($ICXSession.ComputerName -eq $ComputerName2)) -or ($ICXSession.ComputerName -ceq $ComputerName2)) 103 | { 104 | $ICXSessions += $ICXSession 105 | } 106 | } 107 | } 108 | } 109 | 110 | default { 111 | Write-Verbose -Message "No Filter used. Return all Brocade ICX sessions." 112 | 113 | $ICXSessions += $Global:BrocadeICXSessions 114 | } 115 | } 116 | 117 | Write-Verbose -Message "$($ICXSessions.Count) Brocade ICX session(s) found!" 118 | 119 | $ICXSessions 120 | } 121 | 122 | End{ 123 | 124 | } 125 | } -------------------------------------------------------------------------------- /Module/BrocadeICX/Core/Invoke-ICXCommand.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : Invoke-ICXCommand.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Invoke an SSH command in a Brocade ICX sessions 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Invoke an SSH command in a Brocade ICX session 12 | 13 | .DESCRIPTION 14 | Invoke an SSH command into one or multiple Brocade ICX session(s). By default, the function will try to detect the SSH output automatically based on the first and last string. Normally the output starts with the SSH command (which was passed) and ends with SSH@HOSTNAME#. If the automatic detection fails and the timeout is reached, the output which is currently in the SSH stream will be returned. 15 | 16 | If you have trouble with some commands (such as "copy running-config tftp ...""), you should try the compatibility mode (-CompatibilityMode) and define your own timout values (-Seconds or -Milliseconds). With the compatibility mode, the SSH command ist executed and the output of the SSH stream is returned after a specific time. Or if you know the endstring(s) of the output, you can use the parameter "-EndString"" to overwrite the default. 17 | 18 | .EXAMPLE 19 | Get-ICXSession | Invoke-ICXCommand -Command "sh clock" 20 | 21 | SessionID ComputerName Output 22 | --------- ------------ ------ 23 | 0 megatron {14:53:53 GMT+01 Thu Aug 25 2016... 24 | 1 megaTRON {14:53:53 GMT+01 Thu Aug 25 2016... 25 | 2 megatron {14:53:53 GMT+01 Thu Aug 25 2016... 26 | 27 | .EXAMPLE 28 | $Session = Get-ICXSession -SessionID 0 29 | (Invoke-ICXCommand -Command "sh clock" -Session $Session).Output 30 | 31 | 14:54:13 GMT+01 Thu Aug 25 2016 32 | 33 | .EXAMPLE 34 | (Get-ICXSession -SessionID 2 | Invoke-ICXCommand -Command "copy running-config tftp 192.168.XXX.XXX" -CompatibilityMode -Seconds 5).Output 35 | 36 | Upload running-config to TFTP server done. 37 | 38 | .LINK 39 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/Invoke-ICXCommand.README.md 40 | #> 41 | 42 | function Invoke-ICXCommand 43 | { 44 | [CmdletBinding(DefaultParameterSetName='AutoDetectOutput', SupportsShouldProcess=$true)] 45 | param( 46 | [Parameter( 47 | Position=0, 48 | Mandatory=$true, 49 | HelpMessage='SSH command which is executed on the Brocade ICX Switch')] 50 | [String]$Command, 51 | 52 | [Parameter( 53 | Position=1, 54 | ValueFromPipeline=$true, 55 | Mandatory=$true, 56 | HelpMessage='Brocade ICX session')] 57 | [pscustomobject[]]$Session, 58 | 59 | [Parameter( 60 | ParameterSetName='AutoDetectOutput', 61 | Position=2, 62 | HelpMessage='Specifies how many seconds to wait before the reading of the output is canceled (Default=10)')] 63 | [Int32]$Timeout=10, 64 | 65 | [Parameter( 66 | ParameterSetName='AutoDetectOutput', 67 | Position=3, 68 | HelpMessage='Custom string to detect the end of the output (Default=SSH@HOSTNAME#)')] 69 | [String[]]$EndString, 70 | 71 | [Parameter( 72 | ParameterSetName='CompatibilityMode_Milliseconds', 73 | Position=2, 74 | HelpMessage='Use compatibility mode')] 75 | [Parameter( 76 | ParameterSetName='CompatibilityMode_Seconds', 77 | Position=2, 78 | HelpMessage='Use compatibility mode')] 79 | [switch]$CompatibilityMode, 80 | 81 | [Parameter( 82 | ParameterSetName='CompatibilityMode_Seconds', 83 | Position=3, 84 | HelpMessage='Specifies how many seconds to wait before the output is read (Default=1)')] 85 | [Int32]$Seconds=1, 86 | 87 | [Parameter( 88 | ParameterSetName='CompatibilityMode_Milliseconds', 89 | Position=3, 90 | HelpMessage='Specifies how many milliseconds to wait before the output is read (Default=1000)')] 91 | [Int32]$Milliseconds=1000 92 | ) 93 | 94 | Begin{ 95 | 96 | } 97 | 98 | Process{ 99 | # Store the original SSH command for later comparison 100 | $OriginalSSHCommand = $Command.Replace("`n","") 101 | 102 | # Add a line break, to simulate ENTER 103 | if(-not($Command.EndsWith("`n"))) 104 | { 105 | $Command = $Command + "`n" 106 | } 107 | 108 | # Calculate the timeout in Milliseconds 109 | $TimeoutMilliseconds = $Timeout * 1000 110 | 111 | # The last line of the output "normally" contains SSH@HOSTNAME> or SSH@HOSTNAME# or SSH@HOSTNAME(config)# 112 | $RegexSSHatHostname = "(SSH@){1}[0-9A-Z_-]+([(]{1}(config){1}[)]{1})*(>|#){1}" 113 | 114 | # Regex for terminal mode detection (access rights) 115 | $Regex_UserMode = "(SSH@){1}[0-9A-Z_-]+(>){1}" 116 | $Regex_PrivilegedMode = "(SSH@){1}[0-9A-Z_-]+(#){1}" 117 | $Regex_ConfigMode = "(SSH@){1}[0-9A-Z_-]+([(]{1}(config){1}[)]{1})(#){1}" 118 | 119 | # Temporary array to store Brocade ICX sessions which are to be removed later (e.g. if SSH connection was dropped) 120 | $BadICXSessions = @() 121 | 122 | # Go through each session and execute the SSH command 123 | foreach($Session2 in $Session) 124 | { 125 | Write-Verbose -Message "Current session: $Session2" 126 | 127 | # Check if session is a valid Brocade ICX session and managed by this module 128 | if(-not(Test-ICXSession -Session $Session2)) 129 | { 130 | Write-Error -Message "Session ($Session2) is not a valid Brocade ICX session or not managed by the BrocadeICX module!" -Category ConnectionError 131 | continue 132 | } 133 | 134 | if($PSCmdlet.ShouldProcess($Session2.ComputerName)) 135 | { 136 | 137 | # Try to write the SSH command in the SSH shell stream 138 | try{ 139 | Write-Verbose -Message "Write SSH command ""$OriginalSSHCommand"" in the SSH shell stream..." 140 | $Session2.Stream.Write($Command) 141 | } 142 | catch{ 143 | if($_.Exception.Message.Split(':')[1].Trim() -eq '"Client not connected."') 144 | { 145 | Write-Error -Message "Client ""$($Session2.ComputerName)"" (Session: $Session2)) no longer connected! SSH command can not be executed! The session will be removed from the global Brocade ICX sessions." -Category ConnectionError 146 | 147 | # Sessions are removed at the end, to prevent an enumeration error 148 | $BadICXSessions += $Session2 149 | } 150 | else 151 | { 152 | Write-Error -Message "Client ""$($Session2.ComputerName)"" (Session: $Session2): $($_.Exception.Message)" -Category ConnectionError 153 | } 154 | 155 | continue 156 | } 157 | 158 | # Temporary output as array, which is returned from ssh shell stream 159 | $TemporaryOutput = @() 160 | 161 | # Auto detect output or wait a specific time (compatibility mode)... 162 | if($PSCmdlet.ParameterSetName -eq 'AutoDetectOutput') 163 | { 164 | # Validate that the stream was read to the end 165 | $SSHCommandFoundInOutput = $false 166 | $OutputIsComplete = $false 167 | 168 | # Timeout 169 | $TimeoutStartTime = Get-Date 170 | $TimeoutHasReached = $false 171 | 172 | do{ 173 | # Check if timeout is reached, if yes... go the last time through the loop 174 | if((New-TimeSpan -Start $TimeoutStartTime -End (Get-Date)).TotalMilliseconds -gt $TimeoutMilliseconds) 175 | { 176 | 177 | Write-Warning -Message "Timeout ($Timeout seconds) was reached! Output may not complete. If you have problems with this command. Try out the compatibility mode. Use Get-Help for more details!" 178 | $TimeoutHasReached = $true 179 | } 180 | else 181 | { 182 | # Wait for new output 183 | Write-Verbose -Message "Wait 250 Milliseconds." 184 | Start-Sleep -Milliseconds 250 185 | } 186 | 187 | # Get the output and split lines into an array 188 | $Stream_Read = $Session2.Stream.Read() -split '[\n]' | Where-Object {$_} 189 | 190 | # Check if output is not null 191 | if($Stream_Read -ne $null) 192 | { 193 | Write-Verbose -Message "Process received output..." 194 | 195 | # Go through each line 196 | foreach($Line in $Stream_Read) 197 | { 198 | # Add only the output after the SSH command 199 | if(-not($SSHCommandFoundInOutput)) 200 | { 201 | # If the command was found... we can start building the output! (Use like because the line sometimes starts with "SSH@HOSTNAME#" or "SSH@HOSTNAME(config)#") 202 | if($Line -like "*$OriginalSSHCommand*") 203 | { 204 | Write-Verbose -Message "SSH command ""$OriginalSSHCommand"" was found in line." 205 | $SSHCommandFoundInOutput = $true 206 | } 207 | } 208 | else 209 | { 210 | # Check if custom end string is used and is present in the current line 211 | if($PSBoundParameters.ContainsKey('EndString')) 212 | { 213 | foreach($EndString2 in $EndString) 214 | { 215 | if($Line -like "*$EndString2*") 216 | { 217 | Write-Verbose -Message "Output is complete! ""$EndString2"" was found in line: $Line" 218 | $OutputIsComplete = $true 219 | } 220 | } 221 | } # Check if line match regex ("SSH@HOSTNAME>" or "SSH@HOSTNAME#" or "SSH@HOSTNAME(config)#"), if so, we have reached the end of the shell stream 222 | elseif($Line -match $RegexSSHatHostname) 223 | { 224 | Write-Verbose -Message "Output is complete!" 225 | $OutputIsComplete = $true 226 | } 227 | 228 | $TemporaryOutput += $Line 229 | } 230 | } 231 | } 232 | else 233 | { 234 | Write-Verbose -Message "No output received." 235 | } 236 | }while(($OutputIsComplete -eq $false) -and ($TimeoutHasReached -eq $false)) 237 | } 238 | else 239 | { 240 | Write-Verbose -Message "Compatibility mode enabled." 241 | 242 | if($PSCmdlet.ParameterSetName -eq "CompatibilityMode_Seconds") 243 | { 244 | $Milliseconds = $Seconds * 1000 245 | } 246 | 247 | Start-Sleep -Milliseconds $Milliseconds 248 | 249 | $TemporaryOutput += $Session2.Stream.Read() -split '[\n]' | Where-Object {$_} 250 | } 251 | 252 | Write-Verbose -Message "Prepare output..." 253 | 254 | # Output as array, which is returned 255 | $Output = @() 256 | 257 | $AccessMode = [String]::Empty 258 | 259 | # Process the output - replace SSH command and SSH@HOSTNAME> or SSH@HOSTNAME# or SSH@HOSTNAME(config)# 260 | foreach($Line in $TemporaryOutput) 261 | { 262 | # Detect AccessMode while process output... So we do not have to loop through the output twice 263 | if($Line -match $Regex_UserMode) 264 | { 265 | $AccessMode = "User" 266 | } 267 | elseif($Line -match $Regex_PrivilegedMode) 268 | { 269 | $AccessMode = "Privileged" 270 | } 271 | elseif($Line -match $Regex_ConfigMode) 272 | { 273 | $AccessMode = "Config" 274 | } 275 | 276 | $Output += $Line -replace $OriginalSSHCommand, "" -replace $RegexSSHatHostname, "" 277 | } 278 | 279 | # Update session in global array if TerminalMode has changed 280 | if($Session2.AccessMode -ne $AccessMode) 281 | { 282 | Write-Verbose "TerminalMode has changed to: $AccessMode" 283 | 284 | $SessionIndex = $BrocadeICXSessions.IndexOf($Session2) 285 | $Session2.AccessMode = $AccessMode 286 | $BrocadeICXSessions[$SessionIndex] = $Session2 287 | } 288 | 289 | $IndexStart = 0 290 | $IndexEnd = $Output.Length -1 291 | 292 | # Get the index of the first item with content 293 | for($i = 0; $i -lt $IndexEnd; $i++) 294 | { 295 | if($Output[$i] -match '[\S]') 296 | { 297 | Write-Verbose -Message "Index of the first item with content: $i" 298 | $IndexStart = $i 299 | break 300 | } 301 | } 302 | 303 | # Get the index of the last item with content 304 | for($j = $IndexEnd; $j -gt $IndexStart; $j--) 305 | { 306 | if($Output[$j] -match '[\S]') 307 | { 308 | Write-Verbose -Message "Index of the last item with content: $j" 309 | $IndexEnd = $j 310 | break 311 | } 312 | } 313 | 314 | # Build a new array without the empty items at start and end 315 | $Output = $Output[$IndexStart..$IndexEnd] 316 | 317 | # Build the PSCustomObject and return it 318 | [pscustomobject] @{ 319 | SessionID = $Session2.SessionID 320 | ComputerName = $Session2.ComputerName 321 | Output = $Output 322 | } 323 | } 324 | } 325 | 326 | if($BadICXSessions.Count -gt 0) 327 | { 328 | # Cleanup Brocade ICX sessions which are no longer available 329 | Write-Verbose -Message "Removing Brocade ICX sessions which are no longer available." 330 | $BadICXSessions | Remove-ICXSession 331 | } 332 | } 333 | 334 | End{ 335 | 336 | } 337 | } -------------------------------------------------------------------------------- /Module/BrocadeICX/Core/New-ICXSession.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : New-ICXSession.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Create a new Brocade ICX sessions over SSH 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Create a new Brocade ICX sessions over SSH 12 | 13 | .DESCRIPTION 14 | Create one or multiple Brocade ICX session over SSH. If no credentials are submitted, a credential popup will appear. 15 | 16 | .EXAMPLE 17 | New-ICXSession -ComputerName megatron 18 | 19 | SessionID ComputerName AccessMode 20 | --------- ------------ ---------- 21 | 0 megatron Privileged 22 | 23 | .LINK 24 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/New-ICXSession.README.md 25 | #> 26 | 27 | function New-ICXSession 28 | { 29 | [CmdletBinding()] 30 | param( 31 | [Parameter( 32 | Position=0, 33 | Mandatory=$true, 34 | HelpMessage='Hostname or IPv4-Address of the Brocade ICX Switch')] 35 | [String[]]$ComputerName, 36 | 37 | [Parameter( 38 | Position=1, 39 | Mandatory=$false, 40 | HelpMessage='Accept the SSH key')] 41 | [switch]$AcceptKey, 42 | 43 | [Parameter( 44 | Position=2, 45 | Mandatory=$false, 46 | HelpMessage='Credentials to authenticate agains a Brocade ICX Switch (SSH connection)')] 47 | [System.Management.Automation.PSCredential] 48 | [System.Management.Automation.CredentialAttribute()] 49 | $Credential 50 | ) 51 | 52 | Begin{ 53 | 54 | } 55 | 56 | Process{ 57 | # If no credentials are submitted by parameter, prompt the user to enter them 58 | if($Credential -eq $null) 59 | { 60 | try{ 61 | $Credential = Get-Credential $null 62 | } 63 | catch{ 64 | throw "Entering credentials has been canceled by user. Can't establish SSH connection without credentials!" 65 | } 66 | } 67 | 68 | Write-Verbose -Message "Accept key is set to: $AcceptKey" 69 | 70 | # Create a new Brocade ICX session for each Switch 71 | foreach($ComputerName2 in $ComputerName) 72 | { 73 | Write-Verbose -Message "Create new SSH session for ""$ComputerName2""." 74 | 75 | try{ 76 | if($AcceptKey) 77 | { 78 | $Created_SSHSession = New-SSHSession -ComputerName $ComputerName2 -Credential $Credential -AcceptKey -ErrorAction Stop 79 | } 80 | else 81 | { 82 | $Created_SSHSession = New-SSHSession -ComputerName $ComputerName2 -Credential $Credential -ErrorAction Stop 83 | } 84 | 85 | $SessionID = $Created_SSHSession.SessionID 86 | 87 | $SSHSession = Get-SSHSession -SessionId $SessionID 88 | 89 | Write-Verbose -Message "Creating shell stream for ""$ComputerName2""..." 90 | $SSHStream = $SSHSession.Session.CreateShellStream("dumb", 0, 0, 0, 0, 1000) 91 | } 92 | catch{ 93 | Write-Error -Message "$($_.Exception.Message)" -Category ConnectionError 94 | continue 95 | } 96 | 97 | $AccessMode = [String]::Empty 98 | 99 | # Create a new Brocade ICX session object 100 | $ICXSession = [pscustomobject] @{ 101 | SessionID = $SessionID 102 | ComputerName = $ComputerName2 103 | AccessMode = $AccessMode 104 | Session = $SSHSession 105 | Stream = $SSHStream 106 | } 107 | 108 | # Set the default parameter set 109 | $ICXSession.PSObject.TypeNames.Insert(0,'BrocadeICX.ICXSession') 110 | $DefaultDisplaySet = 'SessionID', 'ComputerName', 'AccessMode' 111 | $DefaultDisplayPropertySet = New-Object System.Management.Automation.PSPropertySet('DefaultDisplayPropertySet',[string[]]$DefaultDisplaySet) 112 | $PSStandardMembers = [System.Management.Automation.PSMemberInfo[]]@($DefaultDisplayPropertySet) 113 | $ICXSession | Add-Member MemberSet PSStandardMembers $PSStandardMembers 114 | 115 | # Add it to the global Brocade ICX sessions array 116 | Write-Verbose -Message "Add session ($ICXSession) to global Brocade ICX sessions..." 117 | [void]$Global:BrocadeICXSessions.Add($ICXSession) 118 | 119 | # Make output easier to process 120 | [void](Invoke-ICXCommand -Session $ICXSession -Command "skip-page-display") 121 | 122 | Write-Verbose -Message "Brocade ICX session created!" 123 | 124 | # Return the created Brocade ICX session 125 | Get-ICXSession -SessionID $SessionID 126 | } 127 | } 128 | 129 | End{ 130 | 131 | } 132 | } -------------------------------------------------------------------------------- /Module/BrocadeICX/Core/Remove-ICXSession.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : Remove-ICXSession.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Remove a Brocade ICX session 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Remove a Brocade ICX session 12 | 13 | .DESCRIPTION 14 | Remove one or multiple Brocade ICX sessions. 15 | 16 | .EXAMPLE 17 | Remove-ICXSession -SessionID 1 18 | 19 | .EXAMPLE 20 | Get-ICXSession | Remove-ICXSession 21 | 22 | .EXAMPLE 23 | Remove-ICXSession -ComputerName megatron 24 | 25 | .LINK 26 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/Remove-ICXSession.README.md 27 | #> 28 | 29 | function Remove-ICXSession 30 | { 31 | [CmdletBinding(DefaultParameterSetName='SessionID')] 32 | param( 33 | [Parameter( 34 | ParameterSetName='SessionID', 35 | Position=0, 36 | ValueFromPipelineByPropertyName=$true, 37 | Mandatory=$true, 38 | HelpMessage='ID of the Brocade ICX session')] 39 | [Int32[]]$SessionID, 40 | 41 | [Parameter( 42 | ParameterSetName='ComputerName', 43 | Position=0, 44 | ValueFromPipelineByPropertyName=$true, 45 | Mandatory=$true, 46 | HelpMessage='ComputerName of the Brocade ICX session')] 47 | [String[]]$ComputerName, 48 | 49 | [Parameter( 50 | ParameterSetName='ComputerName', 51 | Position=1, 52 | HelpMessage='ComputerName must match exactly')] 53 | [switch]$CaseSensitive, 54 | 55 | [Parameter( 56 | ParameterSetName='Session', 57 | Position=0, 58 | ValueFromPipeline=$true, 59 | Mandatory=$true, 60 | HelpMessage='Brocade ICX session')] 61 | [pscustomobject[]]$Session 62 | ) 63 | 64 | Begin{ 65 | 66 | } 67 | 68 | Process{ 69 | # Temporary array to store Brocade ICX sessions which are removed 70 | $ICXSessions2Remove = @() 71 | 72 | # Switch between the different parameter sets 73 | switch($PSCmdlet.ParameterSetName) 74 | { 75 | "SessionID" { 76 | $ICXSessions2Remove += Get-ICXSession -SessionID $SessionID 77 | } 78 | 79 | "ComputerName"{ 80 | $ICXSessions2Remove += Get-ICXSession -ComputerName $ComputerName -CaseSensitive:$CaseSensitive 81 | } 82 | 83 | "Session" { 84 | foreach($Session2 in $Session) 85 | { 86 | if(Test-ICXSession -Session $Session2) 87 | { 88 | $ICXSessions2Remove += $Session2 89 | } 90 | else 91 | { 92 | Write-Host -Object "Session ($Session2) is not a valid Brocade ICX session or not managed by the BrocadeICX module!" -ForegroundColor Red 93 | } 94 | } 95 | } 96 | } 97 | 98 | # Remove the Brocade ICX sessions 99 | if($ICXSessions2Remove.Count -gt 0) 100 | { 101 | Write-Verbose -Message "$($ICXSessions2Remove.Count) Brocade ICX session(s) to remove." 102 | 103 | foreach($ICXSession2Remove in $ICXSessions2Remove) 104 | { 105 | Write-Verbose -Message "Remove Brocade ICX session: $ICXSession2Remove" 106 | 107 | # Closing the underlying SSH connection 108 | Write-Verbose -Message "Closing the underlying SSH session..." 109 | [void](Remove-SSHSession -SessionId $ICXSession2Remove.SessionID) 110 | 111 | # Remove the Brocade ICX session from the global array 112 | Write-Verbose -Message "Remove Brocade ICX session from the global Brocade ICX sessions..." 113 | $Global:BrocadeICXSessions.Remove($ICXSession2Remove) 114 | 115 | Write-Verbose -Message "Brocade ICX session removed!" 116 | } 117 | } 118 | } 119 | 120 | End{ 121 | 122 | } 123 | } -------------------------------------------------------------------------------- /Module/BrocadeICX/Core/Test-ICXSession.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : Test-ICXSession.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Test if a session is a valid Brocade ICX session 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Test if a session is a valid Brocade ICX session 12 | 13 | .DESCRIPTION 14 | Test if a session is a valid Brocade ICX session and managed by the BrocadeICX module. 15 | 16 | .EXAMPLE 17 | $Session = Get-ICXSession -SessionID 0 18 | Test-ICXSession -Session $Session 19 | 20 | true 21 | 22 | .EXAMPLE 23 | "Test" | Test-ICXSessions 24 | 25 | false 26 | 27 | .LINK 28 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/Test-ICXSession.README.md 29 | #> 30 | 31 | function Test-ICXSession 32 | { 33 | [CmdletBinding()] 34 | [OutputType('System.Boolean')] 35 | param( 36 | [Parameter( 37 | Position=0, 38 | ValueFromPipeline=$true, 39 | Mandatory=$true, 40 | HelpMessage='Brocade ICX session')] 41 | [pscustomobject]$Session 42 | ) 43 | 44 | Begin{ 45 | 46 | } 47 | 48 | Process{ 49 | Write-Verbose -Message "Check if session is a valid Brocade ICX session..." 50 | 51 | # Go through each Brocade ICX session 52 | foreach($ICXSession in $Global:BrocadeICXSessions) 53 | { 54 | if($ICXSession -eq $Session) 55 | { 56 | Write-Verbose -Message "Valid Brocade ICX session found!" 57 | return $true 58 | } 59 | } 60 | 61 | Write-Verbose -Message "No valid Brocade ICX session found!" 62 | return $false 63 | } 64 | 65 | End{ 66 | 67 | } 68 | } -------------------------------------------------------------------------------- /Module/BrocadeICX/Functions/Interface/Get-ICXInterface.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : Get-ICXInterface.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Get interface(s) from a Brocade ICX Switch 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Get interface(s) from a Brocade ICX Switch 12 | 13 | .DESCRIPTION 14 | Get interface(s) from a Brocade ICX Switch with status [up|down], speed [1G|100M|10M] etc. 15 | 16 | .EXAMPLE 17 | Get-ICXInterface -ComputerName megatron | Select-Object -First 5 | Format-Table 18 | 19 | Port Link State Duplex Speed Trunk Tag Pvid Priority MAC Name 20 | ---- ---- ----- ------ ----- ----- --- ---- -------- --- ---- 21 | 0/1/1 Up Forward Full 1G None Yes N/A 0 0000.0000.0000 UPLINK 22 | 0/1/2 Up Forward Full 1G None No 1001 0 0000.0000.0001 23 | 0/1/3 Up Forward Full 100M None No 1001 0 0000.0000.0002 24 | 0/1/4 Down None None None None No 1 0 0000.0000.0003 25 | 0/1/5 Up Forward Full 1G None No 1001 0 0000.0000.0004 26 | 27 | .LINK 28 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/Get-ICXInterface.README.md 29 | #> 30 | 31 | function Get-ICXInterface 32 | { 33 | [CmdletBinding(DefaultParameterSetName='ComputerName')] 34 | param( 35 | [Parameter( 36 | ParameterSetName='ComputerName', 37 | Position=0, 38 | Mandatory=$true, 39 | HelpMessage='Hostname or IPv4-Address of the Brocade ICX Switch')] 40 | [String[]]$ComputerName, 41 | 42 | [Parameter( 43 | ParameterSetName='Session', 44 | Position=0, 45 | ValueFromPipeline=$true, 46 | Mandatory=$true, 47 | HelpMessage='Brocade ICX session')] 48 | [pscustomobject[]]$Session, 49 | 50 | [Parameter( 51 | ParameterSetName='ComputerName', 52 | Position=1, 53 | HelpMessage='Accept the SSH key')] 54 | [switch]$AcceptKey, 55 | 56 | [Parameter( 57 | ParameterSetName='ComputerName', 58 | Position=2, 59 | HelpMessage='Credentials to authenticate agains the Brocade ICX Switch (SSH connection)')] 60 | [System.Management.Automation.PSCredential] 61 | [System.Management.Automation.CredentialAttribute()] 62 | $Credential 63 | ) 64 | 65 | Begin{ 66 | function get_ICXInterface { 67 | param( 68 | $Session, 69 | $DefaultDisplaySet 70 | ) 71 | 72 | $Output = (Invoke-ICXCommand -Command "show interface brief" -Session $Session).Output 73 | 74 | foreach($Line in $Output) 75 | { 76 | # Only process lines that start with "x\x\xx" 77 | if($Line -match "^[0-9]\/[0-9]\/[0-9]{1,2}") 78 | { 79 | # Line looks like this "x/x/xx Down None None None None No 1 0 xxxx.xxxx.xxxx 80 | # Replace white spaces and split it 81 | $Line_Split = ($Line -replace '\s+', ' ').Split(" ") 82 | 83 | ### $Line_Split 84 | ############### 85 | # Port 86 | # Link 87 | # State 88 | # Duplex 89 | # Speed 90 | # Trunk 91 | # Tag 92 | # Pvid 93 | # Priority 94 | # MAC 95 | # Name 96 | 97 | # If port-name has spaces... 98 | $Name = [String]::Empty 99 | 100 | foreach($Line_Name in $Line_Split[10..($Line_Split.Count -1)]) 101 | { 102 | $Name += $Line_Name + " " 103 | } 104 | 105 | $ICXInterface = [pscustomobject] @{ 106 | SessionID = $Session.SessionID 107 | ComputerName = $Session.ComputerName 108 | Port = $Line_Split[0] 109 | Link = $Line_Split[1] 110 | State = $Line_Split[2] 111 | Duplex = $Line_Split[3] 112 | Speed = $Line_Split[4] 113 | Trunk = $Line_Split[5] 114 | Tagged = $Line_Split[6] 115 | Pvid = $Line_Split[7] 116 | Priority = $Line_Split[8] 117 | MAC = $Line_Split[9] 118 | Name = $Name.TrimEnd() 119 | } 120 | 121 | # Set the default parameter set 122 | $ICXInterface.PSObject.TypeNames.Insert(0,'BrocadeICX.ICXInterface') 123 | $DefaultDisplayPropertySet = New-Object System.Management.Automation.PSPropertySet('DefaultDisplayPropertySet',[string[]]$DefaultDisplaySet) 124 | $PSStandardMembers = [System.Management.Automation.PSMemberInfo[]]@($DefaultDisplayPropertySet) 125 | $ICXInterface | Add-Member MemberSet PSStandardMembers $PSStandardMembers 126 | 127 | $ICXInterface 128 | } 129 | } 130 | } 131 | } 132 | 133 | Process{ 134 | $DefaultDisplaySet = 'Port', 'Link', 'State', 'Duplex', 'Speed', 'Trunk', 'Tagged', 'Pvid', 'Priority', 'MAC', 'Name' 135 | 136 | if($Session.Count -gt 1 -or $ComputerName.Count -gt 1) 137 | { 138 | $DefaultDisplaySet = 'SessionID', 'ComputerName' + $DefaultDisplaySet 139 | } 140 | 141 | switch($PSCmdlet.ParameterSetName) 142 | { 143 | "ComputerName" { 144 | if($Credential -eq $null) 145 | { 146 | # If no credentials are submitted by parameter, prompt the user to enter them 147 | try{ 148 | $Credential = Get-Credential $null 149 | } 150 | catch{ 151 | throw "Entering credentials has been canceled by user. Can't establish SSH connection without credentials!" 152 | } 153 | } 154 | 155 | foreach($ComputerName2 in $ComputerName) 156 | { 157 | $ICXSession = New-ICXSession -ComputerName $ComputerName2 -AcceptKey:$AcceptKey -Credential $Credential 158 | 159 | if($null -ne $ICXSession) 160 | { 161 | get_ICXInterface -Session $ICXSession -DefaultDisplaySet $DefaultDisplaySet 162 | 163 | Remove-ICXSession -Session $ICXSession 164 | } 165 | } 166 | } 167 | 168 | "Session" { 169 | foreach($Session2 in $Session) 170 | { 171 | if(Test-ICXSession -Session $Session2) 172 | { 173 | get_ICXInterface -Session $Session2 -DefaultDisplaySet $DefaultDisplaySet 174 | } 175 | else 176 | { 177 | Write-Error -Message "Session ($Session2) is not a valid Brocade ICX session or not managed by the BrocadeICX module!" -Category ConnectionError 178 | } 179 | } 180 | } 181 | } 182 | } 183 | 184 | End{ 185 | 186 | } 187 | } 188 | -------------------------------------------------------------------------------- /Module/BrocadeICX/Functions/VLAN/Get-ICXVLAN.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : Get-ICXVLAN.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Get VLAN(s) from a Brocade ICX Switch 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Get VLAN(s) from a Brocade ICX Switch 12 | 13 | .DESCRIPTION 14 | Get VLAN(s) from a Brocade ICX Switch as PSCustomObject, which can be further processed. 15 | 16 | .EXAMPLE 17 | Get-ICXVLAN -ComputerName megatron | ? {$_.Name -eq "Test1"} | ft 18 | 19 | ID Name By TaggedPort UntaggedPort 20 | -- ---- -- ---------- ------------ 21 | 1001 Test1 port {0/1/4} {0/1/37, 0/1/39, 0/1/45, 0/1/46} 22 | 23 | .EXAMPLE 24 | New-ICXSession -ComputerName MEGATRON, megatron 25 | Get-ICXVLAN -Session (Get-ICXSession) | ? {$_.Name -eq "Test1"} | ft 26 | 27 | SessionID ComputerName ID Name By TaggedPort UntaggedPort 28 | --------- ------------ -- ---- -- ---------- ------------ 29 | 0 MEGATRON 1001 Test1 port {0/1/4} {0/1/37, 0/1/39, 0/1/45, 0/1/46} 30 | 1 megatron 1001 Test1 port {0/1/4} {0/1/37, 0/1/39, 0/1/45, 0/1/46} 31 | 32 | .LINK 33 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/Get-ICXVLAN.README.md 34 | #> 35 | 36 | function Get-ICXVLAN 37 | { 38 | [CmdletBinding(DefaultParameterSetName='ComputerName')] 39 | param( 40 | [Parameter( 41 | ParameterSetName='ComputerName', 42 | Position=0, 43 | Mandatory=$true, 44 | HelpMessage='Hostname or IPv4-Address of the Brocade ICX Switch')] 45 | [String[]]$ComputerName, 46 | 47 | [Parameter( 48 | ParameterSetName='Session', 49 | Position=0, 50 | ValueFromPipeline=$true, 51 | Mandatory=$true, 52 | HelpMessage='Brocade ICX session')] 53 | [pscustomobject[]]$Session, 54 | 55 | [Parameter( 56 | ParameterSetName='ComputerName', 57 | Position=1, 58 | HelpMessage='Accept the SSH key')] 59 | [switch]$AcceptKey, 60 | 61 | [Parameter( 62 | ParameterSetName='ComputerName', 63 | Position=2, 64 | HelpMessage='Credentials to authenticate agains the Brocade ICX Switch (SSH connection)')] 65 | [System.Management.Automation.PSCredential] 66 | [System.Management.Automation.CredentialAttribute()] 67 | $Credential 68 | ) 69 | 70 | Begin{ 71 | function get_ICXVLAN { 72 | param( 73 | $Session, 74 | $DefaultDisplaySet 75 | ) 76 | 77 | Begin{ 78 | 79 | } 80 | 81 | Process{ 82 | $Output = (Invoke-ICXCommand -Command "show running-config" -Session $Session).Output 83 | 84 | ### $Output 85 | ################################## 86 | # vlan 1 name DEFAULT-VLAN by port 87 | # ! 88 | # vlan 1001 name Test1 by port 89 | # tagged ethe 0/1/1 90 | # untagged ethe 0/1/5 to 0/1/10 91 | # ! 92 | # vlan 1002 name Test2 by port 93 | # tagged ethe 0/1/1 to 0/1/4 94 | # untagged ethe 0/1/11 to 0/1/20 95 | # ! 96 | 97 | $VLAN_Detected = $false 98 | 99 | $VLAN_TaggedPort = @() 100 | $VLAN_UntaggedPort = @() 101 | 102 | # Parse the output and create a pscustomobject 103 | foreach($Line in $Output) 104 | { 105 | $Line = $Line.Trim() 106 | 107 | if($Line.StartsWith("vlan")) 108 | { 109 | $VLAN_Detected = $true 110 | 111 | Write-Verbose "VLAN found in line: ""$Line""" 112 | 113 | $Line_Split = $Line.Split(" ") 114 | 115 | ### $Line_Split 116 | ############### 117 | # vlan 118 | # 1 119 | # name 120 | # Test1 121 | # by 122 | # port 123 | 124 | for($i = 0; $i -lt ($Line_Split.Count - 1); $i++) 125 | { 126 | if($Line_Split[$i] -eq "vlan") 127 | { 128 | [int]$VLAN_ID = $Line_Split[$i + 1] 129 | } 130 | elseif($Line_Split[$i] -eq "name") 131 | { 132 | $VLAN_Name = $Line_Split[$i + 1] 133 | } 134 | elseif($Line_Split[$i] -eq "by") 135 | { 136 | $VLAN_By = $Line_Split[$i + 1] 137 | } 138 | } 139 | } 140 | elseif($Line.StartsWith("tagged")) 141 | { 142 | Write-Verbose "Tagged ports found in line: $Line" 143 | 144 | # Remove " to " and replace it with "-", then split 145 | $Line_Split = $Line.Replace(" to ", "-").Split(" ") 146 | 147 | ### $Line_Split 148 | ############# 149 | # tagged 150 | # ethe 151 | # 0/1/1-0/1/4 152 | 153 | for($i = 0; $i -lt ($Line_Split.Count - 1); $i++) 154 | { 155 | if($Line_Split[$i] -eq "ethe") 156 | { 157 | if($Line_Split[$i + 1].Contains("-")) 158 | { 159 | $StackID = $Line_Split[$i + 1].Split("-")[0].Split("/")[0] 160 | $Slot = $Line_Split[$i + 1].Split("-")[0].Split("/")[1] 161 | $StartPort = $Line_Split[$i + 1].Split("-")[0].Split("/")[2] 162 | $EndPort = $Line_Split[$i + 1].Split("-")[1].Split("/")[2] 163 | 164 | foreach($Port in $StartPort..$EndPort) 165 | { 166 | $VLAN_TaggedPort += [String]::Format("{0}/{1}/{2}", $StackID, $Slot, $Port) 167 | } 168 | } 169 | else 170 | { 171 | $VLAN_TaggedPort += $Line_Split[$i + 1] 172 | } 173 | } 174 | } 175 | } 176 | elseif($Line.StartsWith("untagged")) 177 | { 178 | Write-Verbose "Untagged ports found in line: $Line" 179 | 180 | # Remove " to " and replace it with "-", then split 181 | $Line_Split = $Line.Replace(" to ", "-").Split(" ") 182 | 183 | ### $Line_Split 184 | ############### 185 | # untagged 186 | # ethe 187 | # 0/1/5-0/1/10 188 | 189 | for($i = 0; $i -lt ($Line_Split.Count - 1); $i++) 190 | { 191 | if($Line_Split[$i] -eq "ethe") 192 | { 193 | if($Line_Split[$i + 1].Contains("-")) 194 | { 195 | $StackID = $Line_Split[$i + 1].Split("-")[0].Split("/")[0] 196 | $Slot = $Line_Split[$i + 1].Split("-")[0].Split("/")[1] 197 | $StartPort = $Line_Split[$i + 1].Split("-")[0].Split("/")[2] 198 | $EndPort = $Line_Split[$i + 1].Split("-")[1].Split("/")[2] 199 | 200 | foreach($Port in $StartPort..$EndPort) 201 | { 202 | $VLAN_UntaggedPort += [String]::Format("{0}/{1}/{2}", $StackID, $Slot, $Port) 203 | } 204 | } 205 | else 206 | { 207 | $VLAN_UntaggedPort += $Line_Split[$i + 1] 208 | } 209 | } 210 | } 211 | } 212 | elseif($VLAN_Detected -and $Line.StartsWith("!")) 213 | { 214 | $VLAN_Detected = $false 215 | 216 | Write-Verbose "End of VLAN: $VLAN_ID ($VLAN_Name)!" 217 | 218 | $ICXVLAN = [pscustomobject] @{ 219 | SessionID = $Session.SessionID 220 | ComputerName = $Session.ComputerName 221 | Id = $VLAN_ID 222 | Name = $VLAN_Name 223 | By = $VLAN_By 224 | TaggedPort = $VLAN_TaggedPort 225 | UntaggedPort = $VLAN_UntaggedPort 226 | } 227 | 228 | # Set the default parameter set 229 | $ICXVLAN.PSObject.TypeNames.Insert(0,'BrocadeICX.ICXVLAN') 230 | $DefaultDisplayPropertySet = New-Object System.Management.Automation.PSPropertySet('DefaultDisplayPropertySet',[string[]]$DefaultDisplaySet) 231 | $PSStandardMembers = [System.Management.Automation.PSMemberInfo[]]@($DefaultDisplayPropertySet) 232 | $ICXVLAN | Add-Member MemberSet PSStandardMembers $PSStandardMembers 233 | 234 | $ICXVLAN 235 | 236 | # Clear the variale(s)/array(s) 237 | $VLAN_Name = [String]::Empty 238 | $VLAN_By = [String]::Empty 239 | $VLAN_TaggedPort = @() 240 | $VLAN_UntaggedPort = @() 241 | } 242 | } 243 | } 244 | 245 | End{ 246 | 247 | } 248 | } 249 | } 250 | 251 | Process{ 252 | $DefaultDisplaySet = 'ID', 'Name', 'By', 'TaggedPort', 'UntaggedPort' 253 | 254 | if($Session.Count -gt 1 -or $ComputerName.Count -gt 1) 255 | { 256 | $DefaultDisplaySet = 'SessionID', 'ComputerName' + $DefaultDisplaySet 257 | } 258 | 259 | switch($PSCmdlet.ParameterSetName) 260 | { 261 | "ComputerName" { 262 | if($Credential -eq $null) 263 | { 264 | # If no credentials are submitted by parameter, prompt the user to enter them 265 | try{ 266 | $Credential = Get-Credential $null 267 | } 268 | catch{ 269 | throw "Entering credentials has been canceled by user. Can't establish SSH connection without credentials!" 270 | } 271 | } 272 | 273 | foreach($ComputerName2 in $ComputerName) 274 | { 275 | $ICXSession = New-ICXSession -ComputerName $ComputerName2 -AcceptKey:$AcceptKey -Credential $Credential 276 | 277 | if($null -ne $ICXSession) 278 | { 279 | get_ICXVLAN -Session $ICXSession -DefaultDisplaySet $DefaultDisplaySet 280 | 281 | Remove-ICXSession -Session $ICXSession 282 | } 283 | } 284 | } 285 | 286 | "Session" { 287 | foreach($Session2 in $Session) 288 | { 289 | if(Test-ICXSession -Session $Session2) 290 | { 291 | get_ICXVLAN -Session $Session2 -DefaultDisplaySet $DefaultDisplaySet 292 | } 293 | else 294 | { 295 | Write-Error -Message "Session ($Session2) is not a valid Brocade ICX session or not managed by the BrocadeICX module!" -Category ConnectionError 296 | } 297 | } 298 | } 299 | } 300 | } 301 | 302 | End{ 303 | 304 | } 305 | } -------------------------------------------------------------------------------- /Module/BrocadeICX/Functions/VLAN/Test-ICXVLAN.ps1: -------------------------------------------------------------------------------- 1 | ############################################################################################################### 2 | # Language : PowerShell 4.0 3 | # Filename : Get-ICXVLAN.ps1 4 | # Autor : BornToBeRoot (https://github.com/BornToBeRoot) 5 | # Description : Test if a VLAN exist on a Brocade ICX Switch 6 | # Repository : https://github.com/BornToBeRoot/PowerShell_BrocadeICX 7 | ############################################################################################################### 8 | 9 | <# 10 | .SYNOPSIS 11 | Test if a VLAN exist on a Brocade ICX Switch 12 | 13 | .DESCRIPTION 14 | Test if a VLAN exist on a Brocade ICX Switch. 15 | 16 | .EXAMPLE 17 | Test-ICXVLAN -ComputerName megatron -VlanId 1 18 | 19 | True 20 | 21 | .EXAMPLE 22 | $Cred = Get-Credentials $null 23 | Test-ICXVLAN -ComputerName megatron -VlanId 2 -Credentials $Cred 24 | 25 | False 26 | 27 | .LINK 28 | https://github.com/BornToBeRoot/PowerShell_BrocadeICX/blob/master/Documentation/Function/Get-ICXVLAN.README.md 29 | #> 30 | 31 | function Test-ICXVLAN 32 | { 33 | [CmdletBinding(DefaultParameterSetName='ComputerName')] 34 | param( 35 | [Parameter( 36 | ParameterSetName='ComputerName', 37 | Position=0, 38 | Mandatory=$true, 39 | HelpMessage='Hostname or IPv4-Address of the Brocade ICX Switch')] 40 | [String]$ComputerName, 41 | 42 | [Parameter( 43 | ParameterSetName='Session', 44 | Position=0, 45 | ValueFromPipeline=$true, 46 | Mandatory=$true, 47 | HelpMessage='Brocade ICX session')] 48 | [pscustomobject]$Session, 49 | 50 | [Parameter( 51 | ParameterSetName='ComputerName', 52 | Position=1, 53 | Mandatory=$true, 54 | HelpMessage='VLAN ID which is to tested')] 55 | [Parameter( 56 | ParameterSetName='Session', 57 | Position=1, 58 | Mandatory=$true, 59 | HelpMessage='VLAN ID which is to tested')] 60 | [Int32]$VlanId, 61 | 62 | [Parameter( 63 | ParameterSetName='ComputerName', 64 | Position=2, 65 | HelpMessage='Accept the SSH key')] 66 | [switch]$AcceptKey, 67 | 68 | [Parameter( 69 | ParameterSetName='ComputerName', 70 | Position=3, 71 | HelpMessage='Credentials to authenticate agains the Brocade ICX Switch (SSH connection)')] 72 | [System.Management.Automation.PSCredential] 73 | [System.Management.Automation.CredentialAttribute()] 74 | $Credential 75 | ) 76 | 77 | Begin{ 78 | function test_ICXVLAN { 79 | param( 80 | $Session, 81 | $VlanId 82 | ) 83 | 84 | Begin{ 85 | 86 | } 87 | 88 | Process{ 89 | [Int32[]]$VlanIds = (Get-ICXVLAN -Session $Session).Id 90 | 91 | return $VlanIds.Contains($VlanId) 92 | } 93 | 94 | End{ 95 | 96 | } 97 | } 98 | } 99 | 100 | Process{ 101 | switch($PSCmdlet.ParameterSetName) 102 | { 103 | "ComputerName" { 104 | if($Credential -eq $null) 105 | { 106 | # If no credentials are submitted by parameter, prompt the user to enter them 107 | try{ 108 | $Credential = Get-Credential $null 109 | } 110 | catch{ 111 | throw "Entering credentials has been canceled by user. Can't establish SSH connection without credentials!" 112 | } 113 | } 114 | 115 | foreach($ComputerName2 in $ComputerName) 116 | { 117 | $ICXSession = New-ICXSession -ComputerName $ComputerName2 -AcceptKey:$AcceptKey -Credential $Credential 118 | 119 | if($null -ne $ICXSession) 120 | { 121 | test_ICXVLAN -Session $ICXSession -VlanId $VlanId 122 | 123 | Remove-ICXSession -Session $ICXSession 124 | } 125 | } 126 | } 127 | 128 | "Session" { 129 | foreach($Session2 in $Session) 130 | { 131 | if(Test-ICXSession -Session $Session2) 132 | { 133 | test_ICXVLAN -Session $Session2 -VlanId $VlanId 134 | } 135 | else 136 | { 137 | Write-Error -Message "Session ($Session2) is not a valid Brocade ICX session or not managed by the BrocadeICX module!" -Category ConnectionError 138 | } 139 | } 140 | } 141 | } 142 | } 143 | 144 | End{ 145 | 146 | } 147 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PowerShell | BrocadeICX 2 | 3 | Module and script collection for PowerShell to administrate Brocade ICX switches over SSH. 4 | 5 | ## Description 6 | 7 | This module and collection of usefull scripts, allows you to administrate your Brocade ICX switches over SSH-Protocol with the Windows PowerShell. 8 | 9 | With the "BrocadeICX" module you can establish a connection via SSH to one ore more Brocade ICX switch devices and executing commands without receiving the following error message: `☺Protocol error, doesn't start with scp!` 10 | 11 | You can write tasks like backup the configuration to a TFTP server or get and set VLANs on an interface. 12 | 13 | ## Module 14 | 15 | #### How to install the module? 16 | 17 | * Download the latest version of the module and all scripts from GitHub ([latest release](https://github.com/BornToBeRoot/PowerShell_BrocadeICX/releases/latest)) 18 | * Copy the folder `Module\BrocadeICX` in your profile under `C:\Users\%username%\Documents\WindowsPowerShell\Modules` 19 | * Open up a PowerShell as an admin and set the execution policy: `Set-ExecutionPolicy RemoteSigned` 20 | * Import the "BrocadeICX"-Module with the command `Import-Module BrocadeICX` (Maybe add this command to your PowerShell profile) 21 | 22 | #### Available functions: 23 | 24 | **Folder: [Core](Module/BrocadeICX/Core)** 25 | 26 | | Function | Description | Help | 27 | | :--- | :--- | :---: | 28 | | [Get-ICXSession](Module/BrocadeICX/Core/Get-ICXSession.ps1) | Get a Brocade ICX session | [:book:](Documentation/Function/Get-ICXSession.README.md) | 29 | | [Invoke-ICXCommand](Module/BrocadeICX/Core/Invoke-ICXCommand.ps1) | Invoke an SSH command in a Brocade ICX sessions | [:book:](Documentation/Function/Invoke-ICXCommand.README.md) | 30 | | [New-ICXSession](Module/BrocadeICX/Core/New-ICXSession.ps1) | Create a new Brocade ICX sessions over SSH | [:book:](Documentation/Function/New-ICXSession.README.md) | 31 | | [Remove-ICXSession](Module/BrocadeICX/Core/Remove-ICXSession.ps1) | Remove a Brocade ICX session | [:book:](Documentation/Function/Remove-ICXSession.README.md) | 32 | | [Test-ICXSession](Module/BrocadeICX/Core/Test-ICXSession.ps1) | Test if a session is a valid Brocade ICX session | [:book:](Documentation/Function/Test-ICXSession.README.md) | 33 | 34 | **Folder: [Interface](Module/BrocadeICX/Functions/Interface)** 35 | 36 | | Function | Description | Help | 37 | | :--- | :--- | :---: | 38 | | [Get-ICXInterface](Module/BrocadeICX/Functions/Interface/Get-ICXInterface.ps1) | Get interface(s) from a Brocade ICX switch | [:book:](Documentation/Function/Get-ICXInterface.README.md) | 39 | 40 | **Folder: [VLAN](Module/BrocadeICX/Functions/VLAN)** 41 | 42 | | Function | Description | Help | 43 | | :--- | :--- | :---: | 44 | | [Get-ICXVLAN](Module/BrocadeICX/Functions/VLAN/Get-ICXVLAN.ps1) | Get VLAN from a Brocade ICX switch | [:book:](Documentation/Function/Get-ICXVLAN.README.md) | 45 | | [Test-ICXVLAN](Module/BrocadeICX/Functions/VLAN/Test-ICXVLAN.ps1) | Test if a VLAN exist on a Brocade ICX switch | [:book:](Documentation/Function/Test-ICXVLAN.README.md) | 46 | 47 | ## Scripts 48 | 49 | #### How to install the scripts? 50 | 51 | * Copy the folder `Scripts` to any location you want. 52 | 53 | #### Available scripts: 54 | 55 | | Script | Description | Help | 56 | | :--- | :--- | :---: | 57 | 58 | ## Requirements 59 | 60 | * PowerShell 4.0 61 | * [Posh-SSH](https://github.com/darkoperator/Posh-SSH) by darkoperator to establish an SSH connection ([latest release](https://github.com/darkoperator/Posh-SSH/releases/latest)). 62 | 63 | ## Supported devices (others may also work) 64 | 65 | * ICX6430-24/48 66 | * FastIron WS 624/48 67 | 68 | --------------------------------------------------------------------------------