BGPNeighbors
URI: http://soap.zeus.com/zxtm/1.0/BGPNeighbors/
The BGPNeighbor interface allows management of BGP neighbor objects. Using this interface, you can create, delete and rename BGP neighbor objects, and manage their configuration.
Methods
addBGPNeighbor( names, details ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidInput, InvalidOperation
Add the new named BGP neighbors, using the provided details.
void addBGPNeighbor(
String[] names
BGPNeighbors.Details[] details
)addTrafficManager( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new traffic managers to each of the named neighbors.
void addTrafficManager(
String[] names
String[][] values
)deleteBGPNeighbor( names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError, InvalidOperation
Delete the named BGP neighbors.
void deleteBGPNeighbor(
String[] names
)getAddress( names )
Get the address of the BGP neighbor.
String[] getAddress(
String[] names
)getAdvertisementInterval( names )
Get the minimum interval between the sending of BGP routing updates.
Unsigned Integer[] getAdvertisementInterval(
String[] names
)getAsNumber( names )
Get the AS number for the AS which the neighbor is a member of
Unsigned Integer[] getAsNumber(
String[] names
)getAuthenticationPassword( names )
Get the password to be used for BGP authentication.
String[] getAuthenticationPassword(
String[] names
)getBGPNeighborNames()
Get the names of all of the configured BGP neighbors.
String[] getBGPNeighborNames()getHoldtime( names )
Get the period after which the BGP session with the neighbour is deemed to have become idle - and requires re-establishment - if the neighbour falls silent.
Unsigned Integer[] getHoldtime(
String[] names
)getKeepalive( names )
Get the interval at which BGP keepalive messages are sent to the BGP neighbors, to keep the mutual BGP session established.
Unsigned Integer[] getKeepalive(
String[] names
)getTrafficManager( names ) throws ObjectDoesNotExist
Get the traffic managers that will establish a BGP session with this neighbor.
String[][] getTrafficManager(
String[] names
)removeTrafficManager( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidOperation
Remove the named traffic managers from each named neighbor.
void removeTrafficManager(
String[] names
String[][] values
)renameBGPNeighbor( names, new_names ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Rename each of the named BGP neighbors.
void renameBGPNeighbor(
String[] names
String[] new_names
)setAddress( names, values ) throws InvalidInput, DeploymentError
Set the address of the BGP neighbor.
void setAddress(
String[] names
String[] values
)setAdvertisementInterval( names, values ) throws InvalidInput, DeploymentError
Set the minimum interval between the sending of BGP routing updates.
void setAdvertisementInterval(
String[] names
Unsigned Integer[] values
)setAsNumber( names, values ) throws InvalidInput, DeploymentError
Set the AS number for the AS which the neighbor is a member of
void setAsNumber(
String[] names
Unsigned Integer[] values
)setAuthenticationPassword( names, values ) throws InvalidInput, DeploymentError
Set the password to be used for BGP authentication.
void setAuthenticationPassword(
String[] names
String[] values
)setHoldtime( names, values ) throws InvalidInput, DeploymentError
Set the period after which the BGP session with the neighbour is deemed to have become idle - and requires re-establishment - if the neighbour falls silent.
void setHoldtime(
String[] names
Unsigned Integer[] values
)setKeepalive( names, values ) throws InvalidInput, DeploymentError
Set the interval at which BGP keepalive messages are sent to the BGP neighbors, to keep the mutual BGP session established.
void setKeepalive(
String[] names
Unsigned Integer[] values
)setTrafficManager( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the traffic managers that will establish a BGP session with this neighbor.
void setTrafficManager(
String[] names
String[][] values
)Structures
BGPNeighbors.Details
This structure contains the basic details of a BGP Neighbor: the configuration needed to establish a BGP session with the neighbor, and the traffic managers which will use the neighbor. It is used when creating a new BGP Neighbor configuration object.
struct BGPNeighbors.Details {
# The IPv4 address of the BGP neighbor.
String address;
# The number of the AS in which the BGP neighbor is operating.
Integer as_number;
# The required interval between keepalive messages for BGP sessions with the
# neighbor.
Integer keepalive;
# The maximum interval between keepalive messages for BGP sessions with the
# neighbor to remain established.
Integer holdtime;
# The minimum interval between successive advertisements being sent during a
# BGP session with the neighbor.
Integer advertisement_interval;
# The password shared with the BGP neighbor to authenticate BGP sessions.
String authentication_password;
# The names of the traffic managers that will estabtablish BGP sessions with
# the neighbor.
String[] machines;
}