Skip to content

Commit

Permalink
Doc update : regarding Patty and Example file. (#37)
Browse files Browse the repository at this point in the history
* Update README.md

* Update rc-example.sh

Added PAT Example

* Update README.md

Extended the rc-example

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update rc-example.sh

* Create rc-PATty-example.sh

* Update rc-PATty-example.sh
  • Loading branch information
larslilja authored Sep 5, 2024
1 parent b8766b3 commit f3094cf
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,10 @@ The easiest way to run the tool is to provide all the lab variables in the rc fi
% cat rc-example.sh
export CML_IP='10.0.0.1'
export CML_USER='user1'
export CML_PASSWORD='password123'
export CML_PASSWORD='2ajG$I2?8k'
export MANAGER_IP='10.0.0.10'
export MANAGER_USER='sdwan'
export MANAGER_PASSWORD='sdwanlab123'
export MANAGER_PASSWORD='2ajG$I2?8k'
export MANAGER_MASK='/24'
export MANAGER_GATEWAY='10.0.0.254'
export LAB_NAME='sdwan'
Expand All @@ -141,7 +141,19 @@ Note that if password was not defined, the user will be prompted for a password.

Note that MANAGER_IP can be:
- an IP address: SD-WAN Manager will be reachable over this IP address. By default the IP address should come from the same subnet as CML IP, unless custom bridge is specified during deploy task.
- a PATty port in format "pat:<outside-port>": SD-WAN Manager will be reachable over CML IP port <outside-port>. Before using this option, PATTy needs to be enabled on the CML server as per [CML documentation](https://developer.cisco.com/docs/modeling-labs/patty-tool-overview/).
- a PATty port in format "pat:<outside-port>": SD-WAN Manager will be reachable over CML IP port <outside-port>. Before using this option, PATTy needs to be enabled on the CML server as per [CML documentation](https://developer.cisco.com/docs/modeling-labs/patty-tool-mapping-configuration/).

If you want to use PATty the rc file above will change slighty to the following.

% cat rc-PATty-example.sh
export CML_IP='10.0.0.1'
export CML_USER='user1'
export CML_PASSWORD='2ajG$I2?8k'
export MANAGER_IP='pat:2002'
export MANAGER_USER='sdwan'
export MANAGER_PASSWORD='2ajG$I2?8k'
export LAB_NAME='sdwan-PATty'
% source rc-PATty-example.sh

### Task-specific Parameters
Task-specific parameters and options are defined after the task is provided. Each task has its own set of parameters. Check the task documentation to learn more about task-specific parameters.
Expand Down
23 changes: 23 additions & 0 deletions rc-PATty-example.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Copyright 2024 Cisco Systems, Inc. and its affiliates
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

export CML_IP='10.0.0.1'
export CML_USER='user1'
export CML_PASSWORD='2ajG$I2?8k'
export MANAGER_IP='pat:2002'
export MANAGER_USER='sdwan'
export MANAGER_PASSWORD='2ajG$I2?8k'
export LAB_NAME='sdwan-PATty'

0 comments on commit f3094cf

Please sign in to comment.