Skip to content

Latest commit

 

History

History
101 lines (79 loc) · 5.73 KB

ToDoAndNotes.md

File metadata and controls

101 lines (79 loc) · 5.73 KB
Raw

Notes on vNugglets.VDNetworking PowerShell module

Need to make:

  • Tests (partial, currently, written for interactive test, not fully automated)

Maybe eventually add/update:

  • add .Link related links to each cmdlet to help show what cmdlets are related to which
  • Set-VNVMHostNetworkAdapterVDUplink: add check that, if all specified VMHostNetworkAdapters are already associated with the given UplinkNames, take no action and return a Verbose message to that effect ("already in desired state"); approximate start/finish points for this feature are noted in comments in the code
  • Copy-VNVDTrafficRule -Rule -Ruleset <rulesettowhichtocopy>
  • Set-VNVDTrafficRule -- to update a rule, maybe? (like change qualifier/action?)
  • New-VNVDTrafficRule
    • may need to add logic to ensure it meets requirement stated in API ref of, "There can be a maximum of 1 DvsIpNetworkRuleQualifier, 1 DvsMacNetworkRuleQualifier, and 1 DvsSystemTrafficNetworkRuleQualifier for a total of 3 qualifiers"
  • Set-VNVDTrafficRuleSet -Precedence -Rule
    • to allow for the overwriting of the rules in the ruleset with just the new Rule(s) specified, and to allow setting of Precedence (though, may only ever be one TrafficRuleSet per vDPortgroup)
  • add -RunAsync to New-VNVDTrafficRule, Remove-VNVDTrafficRule, and any other cmdlet where it makes sense
  • add tidbit to makeExamplesMD.ps1 that wraps long lines at about 105 characters or so, so that web presentation of the .md does not require reader to scroll long examples

Done (to at least some extent -- some may have further features to implement):

  • Get-VNVDTrafficFilterPolicyConfig
  • Get-VNVDTrafficRuleSet (returns VNVDTrafficRuleSet object with VDPG property, too)
  • Get-VNVDTrafficRule
  • Get-VNVDTrafficRuleQualifier
  • New-VNVDTrafficRuleQualifier
  • New-VNVDTrafficRuleAction
    • remaining Action types to implement: DvsCopyNetworkRuleAction, DvsGreEncapNetworkRuleAction, DvsLogNetworkRuleAction, DvsMacRewriteNetworkRuleAction, DvsPuntNetworkRuleAction, DvsRateLimitNetworkRuleAction
  • Ruleset object returned from Get-VNVDTrafficRuleSet has property by which to know "parent vDPG", to be used for vDPG reconfig task (need to add vDPG property to return from Get-VNVDTrafficFilterPolicyConfig, Get-VNVDTrafficRuleSet, and Get-VNVDTrafficRule)
  • New-VNVDTrafficRule
    • adds rule(s) to TrafficRuleset
  • Remove-VNVDTrafficRule -Rule[]
    • define cmdlet ConfirmImpact to High
    • removes a given rule from the associated ruleset on the given vDPortgroup
    • implemented, but initially with a bug (now worked around): cannot rely on TrafficRule object's Key property, as that changes with every vDPortgroup reconfig, apparently (so, if iterating through several Rules, after the removal of the 1st one, the keys for the rest in the pipeline are invalid)
      • so, must do the Process differently so that all TrafficRule items per vDPortgroup are removed in one reconfig (or, other, less reliable ways, for which I did not opt)
    • Operating with the understanding/observation that there is only ever one (1) Config.DefaultPortConfig.FilterPolicy.FilterConfig per vDPortgroup with agentName of 'dvfilter-generic-vmware', the FilterConfig that matters for traffic filtering/marking (and, so, one subsequent TrafficRuleset, since a FilterConfig has one TrafficRuleset), even though the .FilterConfig property is of type VMware.Vim.DvsFilterConfig[]; so, using single TrafficRuleset per group of TrafficRules to remove; may need revisited in the future
  • Get-VNVDTrafficRuleAction
  • Set-VNVDTrafficRuleSet -Enabled -TrafficRuleset
    • define cmdlet ConfirmImpact to High
  • Examples/docs

Quick examples:

Get

## Get Traffic Rule Set
Get-VDPortgroup | Get-VNVDTrafficRuleSet
## Get Traffic Rules
Get-VDPortgroup | Get-VNVDTrafficRuleSet | Get-VNVDTrafficRule

New traffic rule, (adding traffic rule to traffic ruleset)

Get-VDPortgroup someVdpg | Get-VNVDTrafficRuleSet | New-VNVDTrafficRule -Rule (New-VNVDTrafficRule -Direction blahh -Qualifier (New-VNVDTrafficRuleQualifier -ParmsHere))

Set ruleset

Get-VDPortgroup someVdpg | Get-VNVDTrafficRuleSet | Set-VNVDTrafficRuleSet -Enabled

Remove some traffic rules

Get-VDPortgroup someVdpg | Get-VNVDTrafficRuleSet | Get-VNVDTrafficRule -Name testRule0, otherRule* | Remove-VNVDTrafficRule

Other

$dvSwName = 'dvSw1'
$dvPgNames = 'dvPg1'

$dvSw = Get-VDSwitch -Name $dvSwName

foreach($pg in (Get-View -Id  $dvSw.ExtensionData.Portgroup | Where {$dvPgNames -contains $_.Name})){
    $spec = New-Object VMware.Vim.DVPortgroupConfigSpec
    $spec.ConfigVersion = $pg.Config.ConfigVersion
    $spec.DefaultPortConfig = New-Object VMware.Vim.VMwareDVSPortSetting
    $spec.DefaultPortConfig.FilterPolicy = New-Object VMware.Vim.DvsFilterPolicy

    $filter = New-Object VMware.Vim.DvsTrafficFilterConfig
    $filter.AgentName = 'dvfilter-generic-vmware'

    $ruleSet = New-Object VMware.Vim.DvsTrafficRuleset
    $ruleSet.Enabled = $true

    $rule =New-Object VMware.Vim.DvsTrafficRule
    $rule.Description = 'Traffic Rule Name'
    $rule.Direction = 'outgoingPackets'

    $action = New-Object VMware.Vim.DvsUpdateTagNetworkRuleAction
    $action.QosTag = 4

    $rule.Action += $action

    $ruleSet.Rules += $rule

    $filter.TrafficRuleSet += $ruleSet

    $spec.DefaultPortConfig.FilterPolicy.FilterConfig += $filter

    $pg.ReconfigureDVPortgroup($spec)
}

Other info: get VDTrafficFilterPolicyConfig: $viewVDPG.Config.DefaultPortConfig.FilterPolicy.FilterConfig