Skip to content

Add function to create and manage Guests #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CedricMoreau wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add function to create and manage Guests #7

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d3c847
Add function to create and manage Guests
Oct 7, 2018
7e07fcb
Fix after first review(need some changes)
Oct 15, 2018
5ebf5d7
fix after review
Jan 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 196 additions & 0 deletions PowerArubaCP/Public/Guest.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
#
# Copyright 2018, Alexis La Goutte <alexis.lagoutte at gmail dot com>
# Copyright 2018, Cédric Moreau <moreaucedric0 at gmail dot com>
#
# SPDX-License-Identifier: Apache-2.0
#

function Get-ArubaCPGuest {

<#
.SYNOPSIS
Get Guest account on Aruba ClearPass

.DESCRIPTION
Get Guest account on Aruba ClearPass

.EXAMPLE
Get-ArubaCPGuest
Get all the guest accounts on Clearpass.
#>

Begin {
}

Process {

$run = Invoke-ArubaCPRestMethod -method "get" -uri "api/guest"

$guest = $run._embedded

$guest.items

}

End {
}
}

function Add-ArubaCPGuest {

<#
.SYNOPSIS
Add Guest account on Aruba ClearPass

.DESCRIPTION
Add Guest account on Aruba ClearPass
.EXAMPLE

Add-ArubaCPGuest -username -company -mail -role -enable
Add the guest account with parameters.
.EXAMPLE

Add-ArubaCPGuest -username matthew -company "Interstellar & Co" -mail [email protected] -role guest -enable True
Add the guest account matthew with company Interstellar & Co, e-mail [email protected] and role guest and enable it on Clearpass.
#>

Param(
[Parameter(Mandatory = $true)]
[String]$username,
[Parameter(Mandatory = $true)]
[String]$company,
[Parameter(Mandatory = $true)]
[String]$mail,
[Parameter(Mandatory = $true)]
[int]$role,
[Parameter(Mandatory = $false)]
[ValidateSet ("True", "False")]
Copy link
Collaborator

@alagoutte alagoutte Oct 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use switch type ? :)

Copy link
Collaborator

@alagoutte alagoutte Oct 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No yet fixed

[string]$enable
)

Begin {
}

Process {

$guest = new-Object -TypeName PSObject

$guest | add-member -name "username" -membertype NoteProperty -Value $username

$guest | add-member -name "visitor_company" -membertype NoteProperty -Value $company

$guest | add-member -name "email" -membertype NoteProperty -Value $mail

if ( $PsBoundParameters.ContainsKey('role'))
{
$guest | add-member -name "role_id" -membertype NoteProperty -Value $role
}

if ( $PsBoundParameters.ContainsKey('enable'))
Copy link
Collaborator

@alagoutte alagoutte Oct 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use switch type it will be more easy

{
switch( $enable ) {
True {
$enable = $true
}
False {
$enable = $false
}
}
$guest | add-member -name "enabled" -membertype NoteProperty -Value $enable
}

$run = Invoke-ArubaCPRestMethod -method "post" -body $guest -uri "api/guest"

$run

}

End {
}
}

function Set-ArubaCPGuest {

<#
.SYNOPSIS
Set information about a guest account.

.DESCRIPTION
Set information about a guest account based on his username on Aruba ClearPass.

.EXAMPLE
Set-ArubaCPGuest -username test [-company] [-mail] [-role (contractor/employee/guest) ] [-enable (true/false)] [-expire (hour/day/week/month/year)]
Set the information of the guest user.

.EXAMPLE
Set-ArubaCPGuest -username matthew -company "Company" -mail [email protected] -role guest -enable true -expire hour
Set the guest account matthew enable, with his company, his email, the role guest and with an expire time of an hour.
#>

Param(
[Parameter(Mandatory = $true)]
[String]$username,
[Parameter(Mandatory = $false)]
[String]$company,
[Parameter(Mandatory = $false)]
[String]$mail,
[Parameter(Mandatory = $false)]
[int]$role,
[Parameter(Mandatory = $false)]
[ValidateSet ("true", "false")]
Copy link
Collaborator

@alagoutte alagoutte Oct 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use switch..

[string]$enable,
[Parameter(Mandatory = $false)]
[int]$expire
)

Begin {
}

Process {

$guest = new-Object -TypeName PSObject

$guest | add-member -name "username" -membertype NoteProperty -Value $username

if ( $PsBoundParameters.ContainsKey('company'))
{
$guest | add-member -name "visitor_company" -membertype NoteProperty -Value $company
}

if ( $PsBoundParameters.ContainsKey('mail'))
{
$guest | add-member -name "email" -membertype NoteProperty -Value $mail
}

if ( $PsBoundParameters.ContainsKey('role'))
{
$guest | add-member -name "role_id" -membertype NoteProperty -Value $role
}

if ( $PsBoundParameters.ContainsKey('enable'))
{
switch( $enable ) {
true {
$enable = $true
}
false {
$enable = $false
}
}
$guest | add-member -name "enabled" -membertype NoteProperty -Value $enable
}

if ( $PsBoundParameters.ContainsKey('expire'))
{
$guest | add-member -name "expire_time" -membertype NoteProperty -Value $expire
}

$run = Invoke-ArubaCPRestMethod -method "patch" -body $guest -uri "api/username/${username}"

$run

}

End {
}
}