Bases: BaseEndpoint
Endpoint to manage IP interfaces on an Alcatel-Lucent OmniSwitch using CLI-based API calls.
create_IP_Interface(name, address=None, mask=None, device='Vlan', vlan_id=None, encap='e2')
Create a new IP interface with specified parameters.
| Parameters: |
-
ifindex
(str)
–
ifindex of the interface.
-
address
(Optional[str], default:
None
)
–
-
mask
(Optional[str], default:
None
)
–
-
vlan
(Optional[int])
–
-
service
(Optional[int])
–
-
encapsulation
(Optional[str])
–
Encapsulation type (‘e2’ or ‘snap’).
|
| Returns: |
-
ApiResult( ApiResult
) –
Result of the creation operation or error response.
|
create_name_interface(name)
Create a new IP interface with the given name.
| Parameters: |
-
name
(str)
–
The logical name of the interface (e.g., ‘int-999’).
|
delete(name)
Delete an existing IP interface.
| Parameters: |
-
name
(str)
–
The logical name of the interface (e.g., ‘int-999’).
|
| Returns: |
-
ApiResult( ApiResult
) –
Result of the deletion operation or error response.
|
edit_IP_Interface(ifindex, address=None, mask=None, device=None, vlan_id=None, forward=None, local_proxy_arp=None, encapsulation=None, primary=None)
Create a new IP interface with specified parameters.
| Parameters: |
-
ifindex
(str)
–
ifindex of the interface.
-
address
(Optional[str], default:
None
)
–
-
mask
(Optional[str], default:
None
)
–
-
vlan
(Optional[int])
–
-
service
(Optional[int])
–
-
encapsulation
(Optional[str], default:
None
)
–
Encapsulation type (‘e2’ or ‘snap’).
-
primary
(Optional[bool], default:
None
)
–
Set as primary interface.
|
| Returns: |
-
ApiResult( ApiResult
) –
Result of the creation operation or error response.
|
list(limit=200)
Retrieve all IP interfaces using MIB-based GET with full object mapping.
| Parameters: |
-
limit
(int, default:
200
)
–
Maximum number of entries to retrieve. Defaults to 200.
|
| Returns: |
-
dict( ApiResult
) –
Dictionary of IP interface entries, keyed by ifIndex.
|