Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

networkpath

This topic describes the verbs, command-line arguments, and API parameters available for the networkpath noun in the BMC Cloud Lifecycle Management SDK.

add

Use networkpath-add from the command line to add network paths.

Command-line syntax
clm networkpath-add [-h] [--waitfor TIME_OUT_SECONDS] --networkpathname NAME --environmentname NAME
--destinationportrange PORT|PORT1-PORT2 --protocol {17,6,1}  [--permit]  [--hidden] [--locked]
[--logged] [--description DESCRIPTION] [--sourceserver NAME|id:<GUID>] [--sourceservice NAME|id:<GUID>]
[--destinationserver NAME|id:<GUID>] [--destinationservice NAME|id:<GUID>]  [--destinationmask DESTINATIONMASK]
[--sourcemask SOURCEMASK] [--sourcenetwork SOURCENETWORK | --sourceaddress SOURCEADDRESS | --sourcenic NAME|id:<GUID>]
[--destinationnetwork DESTINATIONNETWORK | --destinationlbpool DESTINATIONLBPOOL | --destinationaddress DESTINATIONADDRESS
| --destinationnic NAME|id:<GUID>]    

Use networkpath_add to add network paths using the API. This command returns a LogicalCommunicationPath API object with the same attributes and relationships.

API syntax
obj = networkpath_add(gcac, environmentName=None, networkPathName=None, description=None, sourceNetwork=None,
sourceAddress=None, sourceMask=None, sourceService=None, sourceServer=None, sourceNic=None, destinationlbPool=None,
destinationNetwork=None, destinationAddress=None, destinationMask=None, destinationService=None, destinationServer=None,
destinationNic=None, destinationPortRange=None, protocol=None, permit=None, hidden=None, locked=None, logged=None)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument

API parameter

Description

Required?

--networkpathname
networkPathName

Name of the network path to add.

Yes

--environmentname
environmentName

Name of the environment.

Yes

--destinationportrange
destinationPortRange

Single port or a range of ports.

Yes

--protocol
protocol

Protocol identifier: TCP (6) / UDP (17) / ICMP (1)

Yes

--sourcenetwork
sourceNetwork

Source network.

Yes

--sourceaddress
sourceAddress

Source network address

Yes

--sourceNic
sourceNic

Source network interface.

Yes

--sourcenetwork
destinationNetwork

Destination network.

Yes

--destinationlbpool
destinationLbPool

Destination load balancer pool.

Yes

--sourceaddress
destinationAddress

Destination network address

Yes

--sourceNic
destinationNic

Destination network interface.

Yes

--permit
permit

Indicates that traffic is allowed on the network path.

 

--hidden
hidden

Indicates that the network path rule is hidden.

 

--locked
locked

Indicates that the network path rule is locked.

 

--logged
logged

Indicates that traffic matching the network path rule must log an entry for audit.

 

--description
description

Description of the network path rule

 

--sourceserver
sourceServer

Name of the source server for the network path.

 

--sourceservice
sourceService

Name of the source service for the network path.

 

--destinationserver
destinationServer

Name of the destination server for the network path.

 

--destinationservice
destinationService

Name of the destination service for the network path.

 

--sourcemask
sourceMask

Source mask address.

 

--destinationmask
destinationMask

Destination mask address.

 

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

delete

Use networkpath-delete from the command line to delete network paths.

Command-line syntax
clm networkpath-delete [-h] [--waitfor TIME_OUT_SECONDS] --environmentname NAME --networkpathname NAME
--provider NAME|id:<GUID>    

Use networkpath_delete to delete network paths using the API. This command returns a LogicalCommunicationPath API object with the same attributes and relationships.

API syntax
obj = networkpath_delete(gcac, environmentName=None, networkPathName=None, provider=None)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument

API parameter

Description

Required?

--environmentname
environmentName

Name of the environment.

Yes

--nwtworkpathname
networkPathName

Name of the network path

Yes

--provider
provider

Provider name or GUID.

Yes

--waitfor

 

Time in seconds to wait for a response from the server, otherwise return running task details.

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

list

Use networkpath-list from the command line to list network paths.

Command-line syntax
clm networkpath-list [-h] [-l] [-u] [-n] [-s] [-k FIELD_NAME [FIELD_NAME ...]] [--filter FIELD_NAME=VALUE
[FIELD_NAME=VALUE ...]] --environment NAME

Use networkpath_list to list network paths using the API. This command returns a list of LogicalCommunicationPath API objects with the same attributes and relationships.

API syntax
obj = networkpath_list(gcac, environment=None, filters=None, fieldInfo=None)

obj[n].guid returns the GUID
obj[n].name returns the name
...

Command-line argument

API parameter

Description

Required?

--environment
environment

Name of the environment.

Yes

-l

 

List all fields. This parameter does not need a value.

 

-u

 

List only GUIDs. This parameter does not need a value.

 

-n

 

List only names. This parameter does not need a value.

 

-s

 

List GUIDs, names, and status (if applicable). This parameter does not need a value.

 

-k

 

List the field names specified as the value for this parameter.

 

--filter
filters

Filter the output according to the specified criteria.

 

 

fieldInfo

list of OM attributes and relations such as ([‘name’, ‘nic.*’, ‘resourceSet.*’])

 

 

gcac

GenericCloudAPIClient instance/user authentication.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*